Skip to content

cloud: update glossary in TOC and format#22130

Merged
ti-chi-bot[bot] merged 1 commit intopingcap:release-8.5from
lilin90:update-glossary
Dec 1, 2025
Merged

cloud: update glossary in TOC and format#22130
ti-chi-bot[bot] merged 1 commit intopingcap:release-8.5from
lilin90:update-glossary

Conversation

@lilin90
Copy link
Copy Markdown
Member

@lilin90 lilin90 commented Dec 1, 2025

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.

  • 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

@lilin90 lilin90 requested a review from qiancai December 1, 2025 07:24
@lilin90 lilin90 self-assigned this Dec 1, 2025
@lilin90 lilin90 added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. labels Dec 1, 2025
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @lilin90, 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 user experience for TiDB Cloud documentation by improving the organization and accuracy of content. It primarily involves repositioning the 'Glossary' link in the Table of Contents across multiple documentation versions to make it easier for users to find, and correcting a CustomContent attribute in the glossary to ensure accurate plan information is displayed for the 'TiDB X' architecture.

Highlights

  • Glossary Link Relocation: The 'Glossary' link has been moved within the Table of Contents (TOC) files for various TiDB Cloud editions (Essential, Premium, Starter, and general TiDB Cloud) to be more prominent, now appearing directly under the 'FAQs' section for improved discoverability.
  • CustomContent Fix: A formatting issue related to the CustomContent tag within the tidb-cloud-glossary.md file has been resolved. This specifically updates the plan attribute for the 'TiDB X' definition to include the 'dedicated' plan, addressing a bug referenced as tidb-cloud: add the "TiDB X" term to glossary #22095.
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.

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

  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.

@ti-chi-bot ti-chi-bot Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Dec 1, 2025
Copy link
Copy Markdown
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 table of contents in several files to improve the visibility of the Glossary and fixes a content issue in the glossary file itself. The changes to the TOC files are well-structured and consistent. I've added one suggestion to the glossary file to improve the clarity of the CustomContent component, ensuring that users on different plans see accurate information about feature availability.

Comment thread tidb-cloud/tidb-cloud-glossary.md
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Dec 1, 2025
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Dec 1, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-12-01 07:35:06.034958249 +0000 UTC m=+248850.848735821: ☑️ agreed by qiancai.

@lilin90 lilin90 added the lgtm label Dec 1, 2025
@lilin90
Copy link
Copy Markdown
Member Author

lilin90 commented Dec 1, 2025

/approve

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Dec 1, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilin90

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

The pull request process is described 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 the approved label Dec 1, 2025
@ti-chi-bot ti-chi-bot Bot merged commit 7ecd40a into pingcap:release-8.5 Dec 1, 2025
9 checks passed
@lilin90 lilin90 deleted the update-glossary branch December 1, 2025 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/tidb-cloud This PR relates to the area of TiDB Cloud. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/S Denotes a PR that changes 10-29 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.

2 participants