external storage url in tidb cloud (#21058) #21133
Conversation
ti-chi-bot
added
area/tidb-cloud
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @ti-chi-bot, 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!
Summary of Changes
Hello! Gemini here, providing a summary of this pull request. This PR, which appears to be an automated cherry-pick from #21058, focuses on updating the documentation related to external storage URLs, specifically adding details relevant to TiDB Cloud users. The changes involve adding specific parameters for S3 storage in the context of TiDB Cloud and adjusting how links to the external storage documentation are handled in the BACKUP and RESTORE SQL statement pages.
Highlights
- TiDB Cloud S3 Documentation: Detailed documentation for Amazon S3 URI parameters specific to TiDB Cloud has been added to the
external-storage-uri.mdpage. This includes parameters likerole-arnandexternal-idwhich are crucial for cloud environments. - Conditional Content Rendering: The
external-storage-uri.mdpage now uses<CustomContent>tags to differentiate and conditionally render content based on the platform (standard TiDB vs. TiDB Cloud), ensuring users see the most relevant information. - Simplified Documentation Links: The links to the external storage URI documentation within the
BACKUPandRESTORESQL statement pages have been simplified by removing platform-specific conditional rendering, making the link consistent across documentation versions.
Changelog
- TOC-tidb-cloud.md
- Added a link to the updated external storage URI documentation (based on PR description).
- external-storage-uri.md
- Wrapped the existing Amazon S3 URI format description and example in
<CustomContent platform="tidb">tags (Diff 1, Diff 2). - Added a new section for Amazon S3 URI format specifically for TiDB Cloud, wrapped in
<CustomContent platform="tidb-cloud">tags (Diff 2). This section includes detailed parameter descriptions (e.g.,access-key,secret-access-key,session-token,role-arn,external-id) and an example URI forBACKUP/RESTORE. - Wrapped the existing GCS URI example for TiDB Lightning and BR in
<CustomContent platform="tidb">tags (Diff 3).
- Wrapped the existing Amazon S3 URI format description and example in
- sql-statements/sql-statement-backup.md
- Removed platform-specific
<CustomContent>tags around the link to the external storage URI documentation (Diff 1).
- Removed platform-specific
- sql-statements/sql-statement-restore.md
- Removed platform-specific
<CustomContent>tags around the link to the external storage URI documentation (Diff 1).
- Removed platform-specific
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and 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 to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request effectively separates the external storage URI documentation for TiDB and TiDB Cloud using the <CustomContent> tags. The new section for TiDB Cloud S3 parameters is comprehensive and provides valuable information for users. The changes in the BACKUP and RESTORE documentation to remove platform-specific tags around the link to the external storage URI page are also correct, as the target page now covers both scenarios.
Summary of Findings
- Formatting of examples and UI elements: Suggested using backticks for example URLs and ARNs for consistency with the style guide's guidance on paths and code snippets. Also noted that UI element names (pages, fields, dialogs, options) could potentially use backticks for consistency, although they are currently in bold.
- Grammar and sentence structure: Identified repeated words ('click') and long sentences in the notes about configuring IAM roles, suggesting rephrasing for improved clarity and readability.
Merge Readiness
The changes correctly implement the separation of documentation for TiDB and TiDB Cloud. The new content is relevant and detailed. There are a few minor suggestions related to grammar, sentence structure, and formatting for consistency with the style guide. I recommend addressing these minor issues before merging to further enhance the documentation quality. I am unable to approve the pull request directly; please have other reviewers review and approve this code before merging.
|
@gemini-code-assist[bot]: adding LGTM is restricted to approvers and reviewers in OWNERS files. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This is an automated cherry-pick of #21058
First-time contributors' checklist
What is changed, added or deleted? (Required)
Append external storage url document to tidb cloud.
(only for TiDB Cloud)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?