-
Notifications
You must be signed in to change notification settings - Fork 6
Add cloud service usage instructions for IDMP SDK #305
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary of ChangesHello @dingbo8128, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the IDMP SDK documentation by providing crucial guidance for users integrating with the cloud service. It clarifies the distinct authentication mechanism required for cloud environments, ensuring developers can successfully configure their SDKs to interact with the cloud platform by obtaining an authorization token from their browser. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds documentation on how to use the IDMP SDK with the cloud service, for both Chinese and English versions. The changes are clear and provide a necessary workaround for cloud service authentication. My review includes suggestions to make the instructions more specific and user-friendly by explicitly naming the environment variable for the token and providing guidance on how to use it in both Java and Python SDKs. These improvements will help users get started more quickly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Adds documentation on how to use the IDMP SDK when connecting to the cloud service instead of the enterprise edition, in both English and Chinese docs.
Changes:
- Updated the English SDK guide to include a new section describing how to authenticate against the cloud version of IDMP using a token from the browser’s
Authorizationheader. - Updated the Chinese SDK guide with a parallel section describing cloud-service-specific login and token handling.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
i18n/en/docusaurus-plugin-content-docs/current/07-develop/01-sdk.md |
Adds English instructions for using the SDK with the IDMP cloud service and obtaining an auth token from the browser. |
docs/07-develop/01-sdk.md |
Adds the corresponding Chinese instructions for using the SDK with the IDMP cloud service and setting the auth token via environment variables. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
wingwing2005
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
No description provided.