-
Notifications
You must be signed in to change notification settings - Fork 701
cloud: update the link of the Clusters page for TiDB Cloud Starter and Essential #21498
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
base: feature/preview-starter
Are you sure you want to change the base?
cloud: update the link of the Clusters page for TiDB Cloud Starter and Essential #21498
Conversation
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.
Summary of Changes
Hello @qiancai, 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 focuses on a comprehensive update to the TiDB Cloud documentation, aligning it with recent UI changes in the console. The primary goal is to ensure that all references to the 'Clusters' page for TiDB Cloud Starter and Essential tiers are accurately updated to the new 'TiDBs' page, providing users with correct and consistent navigation instructions. This change enhances the user experience by eliminating outdated links and clarifying console pathways for different cluster types.
Highlights
- Documentation Update: Updated numerous documentation files to reflect a change in the TiDB Cloud console, renaming the 'Clusters' page to 'TiDBs' for Starter and Essential cluster tiers.
- Improved Navigation Clarity: Introduced conditional instructions in several documents to guide users to the correct console page ('TiDBs' for Starter/Essential and 'Clusters' for Dedicated) based on their cluster type.
- URL Consistency: Standardized console URLs across various guides, ensuring users are directed to the most current and relevant pages within the TiDB Cloud interface.
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 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 or fill out our survey 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
Thank you for this contribution. The changes correctly update the link for the Clusters page to the new TiDBs page for Starter and Essential tiers. I appreciate the additional improvements in several files that now provide clearer instructions for different cluster tiers (Starter/Essential vs. Dedicated). This greatly improves the documentation's accuracy and usability.
I have one minor suggestion for consistency. Overall, great work!
@@ -35,7 +35,7 @@ For other operating systems, see [Terraform documentation](https://learn.hashico | |||
|
|||
TiDB Cloud API uses HTTP Digest Authentication. It protects your private key from being sent over the network. | |||
|
|||
Currently, TiDB Cloud Terraform Provider does not support managing API keys. So you need to create an API key in the [TiDB Cloud console](https://tidbcloud.com/project/clusters). | |||
Currently, TiDB Cloud Terraform Provider does not support managing API keys. So you need to create an API key in the [TiDB Cloud console](https://tidbcloud.com/tidbs). |
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.
For consistency and accuracy, it's better to link to the root of the TiDB Cloud console when the link text is "TiDB Cloud console". The current link .../tidbs
is specific to Serverless clusters, but API keys are managed at a higher level (e.g., organization settings).
A more general link to https://tidbcloud.com/
would be more accurate for all users and consistent with similar changes in this PR (e.g., in tidb-cloud/serverless-faqs.md
). This also aligns with the style guide's emphasis on technical accuracy and consistency.12
Style Guide References
Currently, TiDB Cloud Terraform Provider does not support managing API keys. So you need to create an API key in the [TiDB Cloud console](https://tidbcloud.com/tidbs). | |
Currently, TiDB Cloud Terraform Provider does not support managing API keys. So you need to create an API key in the [TiDB Cloud console](https://tidbcloud.com/). |
Footnotes
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What is changed, added or deleted? (Required)
This PR makes the following changes:
[**Clusters**](https://tidbcloud.com/console/clusters)
to[**TiDBs**](https://tidbcloud.com/tidbs)
./clusters/<cluster_id>/xxxxx
to/tidbs/<tidb_id>/xxxx
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?