-
Notifications
You must be signed in to change notification settings - Fork 701
release-8.5: integrate Starter and Essential to cloud docs #21523
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
This reverts commit abaa33f.
[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 @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!
I've significantly updated the TiDB Cloud documentation to integrate the newly introduced 'Essential' tier and to reflect the renaming of the 'Serverless' tier to 'Starter'. This change aims to provide clearer guidance for users selecting and managing their TiDB Cloud clusters, from free-tier exploration to production-grade deployments. The updates span across core concepts, development guides, operational procedures, and CLI references, ensuring that all relevant information is consistent with the new tier structure and terminology. This consolidation and clarification will enhance the user experience by streamlining access to pertinent documentation for each TiDB Cloud offering.
Highlights
- New 'Essential' Tier: I've introduced a new 'Essential' tier for TiDB Cloud, designed for production-ready workloads with provisioned capacity and automatic scaling. This tier is currently in public preview on Alibaba Cloud.
- Renaming of 'Serverless' to 'Starter': The 'Serverless' tier has been officially renamed to 'Starter' to better reflect its purpose as an entry point for building with TiDB Cloud. All documentation has been updated to reflect this new terminology.
- Dedicated Documentation TOCs: I've created dedicated Table of Contents (TOC) files for both the 'Starter' and 'Essential' tiers, providing a clearer and more organized documentation structure for users of these specific plans.
- Extensive Documentation Updates: Numerous documentation files have been updated to reflect the introduction of the 'Essential' tier and the 'Starter' renaming. This includes updates to compatibility notes, feature availability, connection instructions, and CLI command descriptions across various guides and reference materials.
- New CLI Command for Essential Cluster Capacity: The
ticloud serverless capacity
CLI command has been introduced to allow users to set minimum and maximum Request Capacity Units (RCUs) for 'Essential' clusters, providing programmatic control over their scaling behavior.
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 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 or fill out our survey 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 effectively integrates the 'Starter' and 'Essential' tier documentation into the main cloud docs, including renaming 'Serverless' to 'Starter'. The changes are extensive and mostly look good, with new Table of Contents files for the different tiers and updates across many documents to reflect the new structure. I've found a bug in a new script and several areas in the documentation where clarity and consistency can be improved. My comments include a fix for the script and suggestions to enhance readability and accuracy in the documentation.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
aea7fb5
to
9c9136a
Compare
9b31a7d
to
204ccf4
Compare
af8c69c
to
60cb9ce
Compare
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?