Skip to content

one console: update "TiDB instances" to avoid misunderstanding #22602

Open
qiancai wants to merge 1 commit intopingcap:feature/preview-one-consolefrom
qiancai:update-tidb-instances
Open

one console: update "TiDB instances" to avoid misunderstanding #22602
qiancai wants to merge 1 commit intopingcap:feature/preview-one-consolefrom
qiancai:update-tidb-instances

Conversation

@qiancai
Copy link
Collaborator

@qiancai qiancai commented Mar 20, 2026

… FAQs for consistency across TiDB Cloud documentation

First-time contributors' checklist

What is changed, added or deleted? (Required)

  • Replace “TiDB instances” with “TiDB nodes” where “TiDB instances” actually refers to TiDB nodes.
  • Remove “All TiDB instances” from tidb-cloud/premium/built-in-monitoring-premium.md, because in this context it refers to the current TiDB Cloud Premium instance and is therefore redundant.

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

… FAQs for consistency across TiDB Cloud documentation
@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 20, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign icemap for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 20, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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

  • Terminology Update: Updated instances of 'TiDB instances' to 'TiDB nodes' across multiple documentation files for improved clarity and consistency.
  • Monitoring Metrics Descriptions: Refined descriptions for various monitoring metrics in built-in monitoring, Datadog, and New Relic integration guides to use the updated terminology and remove redundant phrases.
  • Navigation Tip Enhancement: Expanded a tip in the premium built-in monitoring guide to clarify that the combo box can switch between organizations, projects, and resources.

🧠 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 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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. 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

  1. 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.

@qiancai qiancai self-assigned this Mar 20, 2026
@qiancai qiancai added area/tidb-cloud This PR relates to the area of TiDB Cloud. cherry-pick-release-cloud/no-need No need to cherry pick this PR to the "release-cloud" branch. translation/no-need No need to translate this PR. and removed cherry-pick-release-cloud/no-need No need to cherry pick this PR to the "release-cloud" branch. labels Mar 20, 2026
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Mar 20, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tidb-cloud This PR relates to the area of TiDB Cloud. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant