-
Notifications
You must be signed in to change notification settings - Fork 702
cloud: add Terraform doc of essential cluster #21737
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
Conversation
Signed-off-by: FingerLeader <[email protected]>
Hi @FingerLeader. Thanks for your PR. I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
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 @FingerLeader, 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 significantly expands and refines the TiDB documentation. It introduces new content for TiDB Cloud's 'Essential' and 'Starter' cluster offerings, integrating them into the existing Table of Contents structures. The changes also encompass comprehensive updates to various documentation pages, detailing new functionalities like advanced indexing, optimized batch operations, and improved in-memory engine capabilities. The overall aim is to enhance clarity, consistency, and completeness of the documentation for both new and existing users.
Highlights
- New TiDB Cloud Cluster Documentation: Introduced comprehensive documentation for TiDB Cloud 'Essential' and 'Starter' cluster types, including dedicated Tables of Contents and updated terminology across the documentation set.
- Feature Documentation Enhancements: Added and updated documentation for several key features, such as multi-column indexes, batch processing capabilities (including Pipelined DML), and the TiKV MVCC in-memory engine, providing detailed explanations and usage guides.
- General Documentation Improvements: Performed extensive updates across various documentation pages, including best practices, tool usage, and SQL functions, to improve clarity, consistency, and accuracy, along with administrative changes to project ownership.
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. 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
-
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 adds a new documentation page explaining how to manage TiDB Cloud Essential clusters using the tidbcloud_serverless_cluster
Terraform resource. The new document covers creating, modifying, importing, and deleting these clusters. My review focuses on improving clarity, conciseness, and technical accuracy to align with the documentation style guide. I've suggested several wording improvements and a correction to a link to ensure the documentation is easy for users to follow.
tidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.md
Show resolved
Hide resolved
tidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.md
Outdated
Show resolved
Hide resolved
tidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.md
Outdated
Show resolved
Hide resolved
Signed-off-by: FingerLeader <[email protected]>
@zhangyangyu: adding LGTM is restricted to approvers and reviewers in OWNERS files. In response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
fb71fb9
to
8ca697a
Compare
8ca697a
to
80fac46
Compare
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
0c5d66d
to
df52e40
Compare
/ok-to-test |
@qiancai: Your lgtm message is repeated, so it is ignored. In response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
/ok-to-test |
tidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Aolin <[email protected]>
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
First-time contributors' checklist
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?