-
Notifications
You must be signed in to change notification settings - Fork 701
cloud release-8.1: remove serverless specific docs #21337
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.1
Are you sure you want to change the base?
Conversation
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.
Summary of Changes
Hello @qiancai, 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 primarily focuses on streamlining and updating the documentation for the release-8.1
branch. It involves removing outdated or serverless-specific content, reorganizing existing sections for better clarity, and adding new documentation for features and tools relevant to TiDB's self-managed and dedicated cloud offerings. The changes aim to provide a more accurate, comprehensive, and user-friendly documentation experience for the current release.
Highlights
- Documentation Scope Adjustment: The pull request significantly refines the documentation scope for the
release-8.1
branch by removing content specifically tied to TiDB Cloud Serverless, as indicated by the PR title and changes inTOC-tidb-cloud.md
and_docHome.md
. - Content Reorganization and Expansion: Key documentation files like
TOC-tidb-cloud.md
andTOC.md
have undergone extensive restructuring. This includes the introduction of new sections for 'Key Concepts', 'Vector Search', and 'Disaster Recovery', alongside detailed API and CLI references, indicating a shift towards a more structured and comprehensive guide for dedicated/self-managed offerings. - Version Alignment and Maintenance: The
README.md
andTOC.md
files are updated to reflectrelease-8.1
as a Long-Term Support (LTS) version, and new release notes for various versions (v8.5, v8.1, v7.5, v7.1, v6.5) have been added, ensuring the documentation remains current and accurate. - Terminology Standardization: Across numerous documentation files, terminology has been standardized, with 'TiDB Serverless' updated to 'TiDB Cloud Serverless', 'TiDB Dedicated' to 'TiDB Cloud Dedicated', and 'TiDB Self-Hosted' to 'TiDB Self-Managed', improving consistency and clarity.
- New Language Support and Utilities: A new C# sample application guide (
develop/dev-guide-sample-application-cs.md
) has been added, and new utility functions (functions-and-operators/utility-functions.md
) and TiDB-specific functions (functions-and-operators/tidb-functions.md
) are now documented, expanding the range of supported development practices.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
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 issue 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 is currently in preview and 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 to provide feedback.
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
-
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. ↩
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 pull request removes entries for TiDB Cloud Serverless from the main Table of Contents (TOC-tidb-cloud.md
), which aligns with the stated goal of removing serverless-specific 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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What is changed, added or deleted? (Required)
This PR removes TiDB Cloud Serverless specific docs from TiDB Cloud Documentation at https://docs.pingcap.com/tidbcloud/.
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?