Update tidb-cloud-poc.md (#21336) #21411
Conversation
Add a pre-condition of to create Dedicated cluster during PoC. Payment method is required to create Dedicated clsuter during PoC
ti-chi-bot
added
area/tidb-cloud
|
[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 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ti-chi-bot, 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 updates the TiDB Cloud Proof of Concept (PoC) documentation to clarify the prerequisites for creating a Dedicated cluster. It specifically adds information about the necessity of having a payment method on file before proceeding with cluster creation for PoC purposes.
Highlights
- Documentation Clarification: A new note has been added to the
tidb-cloud-poc.mddocument, emphasizing that users must provide a payment method (credit card, wire transfer, or cloud marketplace account) before they can create a TiDB Cloud Dedicated cluster for a Proof of Concept. The note also assures users that PoC credits will be applied to eligible expenses.
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.
Code Review
This PR adds a helpful note to the PoC documentation about the payment method prerequisite for creating a Dedicated cluster. The change is well-written. I have a couple of minor suggestions to further improve it by adding a helpful link and rephrasing a sentence for better clarity and conciseness.
My review is guided by the provided documentation style guide, specifically focusing on:
- Completeness (Line 14)
- Conciseness (Line 24)
- Avoiding passive voice (Lines 43-45)
| > | ||
| > Before creating a TiDB Cloud Dedicated cluster, you must add one of the following payment methods: | ||
| > - Add a credit card by following the on-screen instructions on the cluster creation page. | ||
| > - Contact the TiDB Cloud Support team to pay by wire transfer. |
There was a problem hiding this comment.
To help users easily find how to contact the support team, it would be beneficial to link 'TiDB Cloud Support team' to the relevant support page. This improves the completeness of the documentation.1
Style Guide References
| > - Contact the TiDB Cloud Support team to pay by wire transfer. | |
| > - Contact the [TiDB Cloud Support team](/tidb-cloud/tidb-cloud-support.md) to pay by wire transfer. |
Footnotes
| > - Contact the TiDB Cloud Support team to pay by wire transfer. | ||
| > - Sign up for TiDB Cloud through a cloud marketplace (AWS, Azure, or Google Cloud) to pay using your cloud provider account. | ||
| > | ||
| > Your PoC credits will automatically be used to offset eligible expenses incurred during the PoC period. |
There was a problem hiding this comment.
For better readability and conciseness, you can rephrase this sentence to use active voice and simpler wording. This also aligns with the style guide's preference for avoiding passive voice and unnecessary words.12
Style Guide References
| > Your PoC credits will automatically be used to offset eligible expenses incurred during the PoC period. | |
| > Your PoC credits automatically cover eligible expenses during the PoC period. |
Footnotes
-
The style guide recommends avoiding unnecessary words and repetition to keep the documentation concise. (link) ↩
-
The style guide advises against overusing passive voice, suggesting active voice for clearer and more direct sentences (e.g., 'TiUP starts the cluster' instead of 'The cluster is started by TiUP'). (link) ↩
This is an automated cherry-pick of #21336
Add a pre-condition of to create Dedicated cluster during PoC. Payment method is required to create Dedicated clsuter during PoC
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?