-
Notifications
You must be signed in to change notification settings - Fork 701
cloud release-8.5: remove serverless specific docs #21418
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?
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 |
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 undertakes a significant documentation overhaul, primarily by removing content specific to TiDB Cloud Serverless and reorganizing the remaining documentation for better structure and readability. It also integrates new feature documentation and updates system-level configuration guides to align with the latest product versions and best practices.
Highlights
- Documentation Scope Adjustment: This pull request primarily focuses on removing documentation sections and files specific to TiDB Cloud Serverless, streamlining the content for other TiDB offerings and future releases.
- Content Restructuring and Enhancement: Significant reorganization of the Table of Contents for both TiDB Cloud and TiDB Self-Managed documentation has been implemented, introducing new high-level categories and updating existing content for improved clarity and navigation.
- New Feature Documentation Integration: Documentation for several new features, including the Index Advisor, TiKV MVCC In-Memory Engine, Batch Processing, Utility Functions, and Multi-Column Indexes, has been added or updated across various files.
- Version Alignment and Link Maintenance: Numerous internal links have been updated to reflect the
release-8.5
branch, ensuring consistency and accuracy. Additionally, the.lycheeignore
file has been expanded to manage new external references. - Administrative and System Configuration Updates: Updates include changes to the
OWNERS
file for team roles, refined operating system and hardware requirements, and detailed instructions for system configurations like swap, firewall, and SELinux.
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 PR removes documentation specific to TiDB Cloud Serverless from the TOC. A follow-up PR might be needed to address other documentation files that still reference Serverless-specific features.
What is changed, added or deleted? (Required)
This PR removes TiDB Cloud Serverless specific docs from TiDB Cloud Documentation at 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?