-
Notifications
You must be signed in to change notification settings - Fork 705
release-8.5: add Premium TOC #21881
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
base: release-8.5
Are you sure you want to change the base?
release-8.5: add Premium TOC #21881
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 @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 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 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.
TOC-tidb-cloud-premium.md
Outdated
- [TiKV Overview](/tikv-overview.md) | ||
- [RocksDB Overview](/storage-engine/rocksdb-overview.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.
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.
- [TiKV Overview](/tikv-overview.md) | |
- [RocksDB Overview](/storage-engine/rocksdb-overview.md) | |
- [TiKV Overview](/tikv-overview.md) | |
- [RocksDB Overview](/storage-engine/rocksdb-overview.md) |
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) |
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.
Not sure whether this doc applicable to TiDB Cloud Premium
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.
@qqqdan It seems that this file should be removed?
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?