-
Notifications
You must be signed in to change notification settings - Fork 704
Update TOC-tidb-cloud-premium.md #21942
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
|
[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 |
Summary of ChangesHello @qqqdan, 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 addresses a minor but important documentation correction within the TiDB Cloud Premium table of contents. The change ensures that users navigating the premium documentation are accurately directed to the guide for creating a premium TiDB Cloud cluster, thereby enhancing the user experience and the precision of the documentation. Highlights
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 correctly updates the 'Create a TiDB Cloud Cluster' link to its 'premium' version, which aligns with the purpose of this Table of Contents file. However, this change is incomplete as many other related links in the file still point to 'serverless' documentation. I've added a comment to highlight the need for updating these other links to ensure a consistent and clear user journey for the TiDB Cloud Premium offering.
| - [Select Your Cluster Plan](/tidb-cloud/select-cluster-tier.md) | ||
| - Manage TiDB Cloud Clusters | ||
| - [Create a TiDB Cloud Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) | ||
| - [Create a TiDB Cloud Cluster](/tidb-cloud/create-tidb-cluster-premium.md) |
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.
While updating this link to the ...-premium.md version is the correct step for this 'premium' TOC, the change is incomplete. Several related links in this 'Manage Cluster' section still point to ...-serverless.md documentation, which creates an inconsistent experience for users.
To ensure consistency, please also update the following links to their 'premium' equivalents in this PR:
- Line 136:
[Connection Overview](/tidb-cloud/connect-to-tidb-cluster-serverless.md) - Line 137:
[Connect via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) - Line 139:
[Back Up and Restore TiDB Cloud Data](/tidb-cloud/backup-and-restore-serverless.md)
There may be other 'serverless' links throughout the file that also need to be updated.
First-time contributors' checklist
What is changed, added or deleted? (Required)
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?