Skip to content

Conversation

lilin90
Copy link
Member

@lilin90 lilin90 commented Oct 10, 2025

What is changed, added or deleted? (Required)

This PR applies the changes in #21790 to the release-8.5 branch.

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)?

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 review from qiancai and qqqdan October 10, 2025 06:48
@lilin90 lilin90 self-assigned this Oct 10, 2025
@lilin90 lilin90 added translation/no-need No need to translate this PR. for-cloud-release This PR is related to TiDB Cloud release. labels Oct 10, 2025
Copy link

ti-chi-bot bot commented Oct 10, 2025

[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 ask for approval from lilin90. 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.

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

Copy link

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 introduces a dedicated Table of Contents for TiDB Cloud Premium documentation to the release-8.5 branch. The primary goal is to provide a more structured and easily navigable overview of the extensive TiDB Cloud features, development guides, management procedures, and reference materials, thereby improving the user experience for accessing relevant information.

Highlights

  • New Table of Contents (TOC): A new file, TOC-tidb-cloud-premium.md, has been added, introducing a comprehensive Table of Contents specifically for TiDB Cloud Premium documentation.
  • Documentation Structure: The new TOC organizes documentation into key sections such as 'GET STARTED', 'DEVELOP', 'GUIDES', 'REFERENCE', 'RELEASES', and 'Support Plan', enhancing navigation and discoverability for users.
  • Backport from Premium V1 change #21790: This pull request backports the changes originally introduced in pull request Premium V1 change #21790 to the release-8.5 branch.
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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 10, 2025
Copy link

@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 PR adds a new Table of Contents file for TiDB Cloud Premium. My review focuses on ensuring the new file adheres to the documentation style guide. I've suggested changes to use sentence case for headings and list items for consistency, remove a development comment, fix an indentation inconsistency, and add a newline at the end of the file.

Comment on lines 598 to 599
- [TiKV Overview](/tikv-overview.md)
- [RocksDB Overview](/storage-engine/rocksdb-overview.md)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

The indentation for this sublist is 4 spaces, while other sublists in this file use a 2-space indentation. For consistency, please use a 2-space indentation here.

Suggested change
- [TiKV Overview](/tikv-overview.md)
- [RocksDB Overview](/storage-engine/rocksdb-overview.md)
- [TiKV Overview](/tikv-overview.md)
- [RocksDB Overview](/storage-engine/rocksdb-overview.md)

@lilin90 lilin90 added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 10, 2025
Corrected the indentation of TiKV and its overview links under the Storage Engines section to improve TOC structure and readability.
- [TiDB Cloud Partners](/tidb-cloud/tidb-cloud-partners.md)
- [MSP Customer](/tidb-cloud/managed-service-provider-customer.md)
- [Reseller's Customer](/tidb-cloud/cppo-customer.md)
- [{{{ .starter }}} and Essential Limitations](/tidb-cloud/serverless-limitations.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure whether this doc applicable to TiDB Cloud Premium

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@qqqdan It seems that this file should be removed?

@lilin90 lilin90 added the area/tidb-cloud This PR relates to the area of TiDB Cloud. label Oct 14, 2025
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. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. for-cloud-release This PR is related to TiDB Cloud release. size/XXL Denotes a PR that changes 1000+ 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