one console: update "TiDB instances" to avoid misunderstanding #22602
one console: update "TiDB instances" to avoid misunderstanding #22602qiancai wants to merge 1 commit intopingcap:feature/preview-one-consolefrom
Conversation
… FAQs for consistency across TiDB Cloud documentation
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello, 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 enhancing the precision and uniformity of the documentation by standardizing the terminology used to refer to TiDB components. The primary change involves replacing 'TiDB instances' with 'TiDB nodes' to prevent potential misunderstandings and ensure a consistent vocabulary throughout the guides. Additionally, descriptions for monitoring metrics and a navigation tip have been refined to reflect these changes and improve overall readability. 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. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request updates the term 'TiDB instances' to 'TiDB nodes' across several documentation files to improve terminological consistency. The changes also include refining metric descriptions for premium-tier clusters to better abstract underlying infrastructure details. The updates are accurate and improve the documentation's clarity. I have one minor suggestion to rephrase a metric description for better readability and consistency.
… FAQs for consistency across TiDB Cloud documentation
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?