cloud: add the instance creation doc for Premium #21905
Conversation
ti-chi-bot
bot
added
the
missing-translation-status
Summary of ChangesHello @qqqdan, 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 the TiDB Cloud documentation by adding three new markdown files. These documents provide essential information for users, covering the creation of new Starter and Essential cluster types, a comprehensive guide to TiDB Cloud's billing model, and an updated overview of the platform's features and architecture. The additions aim to clarify and detail the evolving TiDB Cloud offerings, including support for new cloud providers like Alibaba Cloud in relevant sections. Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
ti-chi-bot
bot
added
the
size/XXL
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds three new documentation files related to TiDB Cloud's Starter and Essential clusters. The new documents cover creating a cluster, billing information, and a general introduction. My review focuses on improving clarity, conciseness, and correcting some grammatical errors and a typo, in accordance with the repository's style guide. The suggestions aim to make the documentation easier for users to understand.
|
|
||
| 6. Sign in with your TiDB Cloud account. The **Link to Your Azure Billing Account** page is displayed. | ||
|
|
||
| 7. On the **Link to Your Azure Billing Account** page, select your target organization and click **Link** to link to your AWS billing account. |
There was a problem hiding this comment.
There is a typo here. It should refer to an "Azure billing account" instead of an "AWS billing account". This is misleading for users following the Azure-specific instructions. 1
| 7. On the **Link to Your Azure Billing Account** page, select your target organization and click **Link** to link to your AWS billing account. | |
| 7. On the **Link to Your Azure Billing Account** page, select your target organization and click **Link** to link to your Azure billing account. |
Style Guide References
Footnotes
-
The style guide requires maintaining technical accuracy and terminology consistency. ↩
|
|
||
| If you are in the `Organization Owner` or `Organization Billing Manager` role of your organization, you can view and export the billing details of TiDB Cloud. Otherwise, skip this section. | ||
|
|
||
| After setting the payment method, TiDB Cloud will generate the invoice and billing details of the historical months, and generate the bill details of the current month at the beginning of each month. The billing details include your organization's TiDB cluster usage consumption, discounts, backup storage costs, data transmission costs, support service cost, credit consumption, and project splitting information. |
There was a problem hiding this comment.
This sentence is very long and contains a lot of information, which can make it hard to read. Breaking it into smaller sentences would improve clarity. Also, "bill details" should be consistent with the section title "Billing details". 1
| After setting the payment method, TiDB Cloud will generate the invoice and billing details of the historical months, and generate the bill details of the current month at the beginning of each month. The billing details include your organization's TiDB cluster usage consumption, discounts, backup storage costs, data transmission costs, support service cost, credit consumption, and project splitting information. | |
| After setting the payment method, TiDB Cloud generates the invoice and billing details for historical months, and generates the billing details for the current month at the beginning of each month. The billing details include your organization's TiDB cluster usage consumption, discounts, backup storage costs, data transmission costs, support service cost, credit consumption, and project splitting information. |
Style Guide References
Footnotes
-
The style guide recommends paying attention to logical flow and sentence structure for better readability. ↩
| 1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner. | ||
| 2. In the left navigation pane, click **Billing**. | ||
| 3. On the **Billing** page, click the **Cost Explorer** tab. | ||
| 4. On the **Cost Explorer** tab, expand the **Filter** section in the upper-right corner to customize your report. You can set the time range, select a grouping option (such as by service, project, cluster, region, product type, and charge type), and apply filters by selecting specific services, projects, clusters, or regions. The cost explorer will display you with the following information: |
There was a problem hiding this comment.
The phrase "display you with" is grammatically incorrect. It should be "display" or "provide you with". 1
| 4. On the **Cost Explorer** tab, expand the **Filter** section in the upper-right corner to customize your report. You can set the time range, select a grouping option (such as by service, project, cluster, region, product type, and charge type), and apply filters by selecting specific services, projects, clusters, or regions. The cost explorer will display you with the following information: | |
| 4. On the **Cost Explorer** tab, expand the **Filter** section in the upper-right corner to customize your report. You can set the time range, select a grouping option (such as by service, project, cluster, region, product type, and charge type), and apply filters by selecting specific services, projects, clusters, or regions. The cost explorer will display the following information: |
Style Guide References
Footnotes
-
The style guide requires correcting grammar, spelling, and punctuation mistakes. ↩
| </CustomContent> | ||
|
|
||
| After you contact our sales for receiving an invoice on a monthly basis, TiDB Cloud will generate the invoice for the previous month at the beginning of each month. |
There was a problem hiding this comment.
The phrase "for receiving" is slightly awkward. Using "to receive" is more natural and improves readability. 1
| After you contact our sales for receiving an invoice on a monthly basis, TiDB Cloud will generate the invoice for the previous month at the beginning of each month. | |
| After you contact our sales to receive an invoice on a monthly basis, TiDB Cloud will generate the invoice for the previous month at the beginning of each month. |
Style Guide References
Footnotes
-
The style guide prioritizes clarity and simplicity in writing. ↩
|
|
||
| For each monthly invoice: | ||
|
|
||
| - TiDB Cloud provides the invoice to you on the ninth of each month. From the first to the ninth day, you cannot view the last month's cost details, but can obtain the cluster usage information of this month via the billing console. |
There was a problem hiding this comment.
The word "via" can be seen as informal in technical writing. Using "in" or "from" would be more appropriate here. 1
| - TiDB Cloud provides the invoice to you on the ninth of each month. From the first to the ninth day, you cannot view the last month's cost details, but can obtain the cluster usage information of this month via the billing console. | |
| - TiDB Cloud provides the invoice to you on the ninth of each month. From the first to the ninth day, you cannot view the last month's cost details, but can obtain the cluster usage information of this month in the billing console. |
Style Guide References
Footnotes
-
The style guide encourages clear and simple language. ↩
|
|
||
| ## Why TiDB Cloud | ||
|
|
||
| TiDB Cloud allows you with little or no training to handle complex tasks such as infrastructure management and cluster deployment easily. |
There was a problem hiding this comment.
The sentence structure is a bit awkward. Rephrasing it will improve readability and flow. 1
| TiDB Cloud allows you with little or no training to handle complex tasks such as infrastructure management and cluster deployment easily. | |
| With little or no training, TiDB Cloud allows you to easily handle complex tasks such as infrastructure management and cluster deployment. |
Style Guide References
Footnotes
-
The style guide recommends focusing on logical flow and sentence structure. ↩
|
|
||
| - **World-Class Support** | ||
|
|
||
| Get world-class support through our support portal, <a href="mailto:[email protected]">email</a>, chat, or video conferencing. |
There was a problem hiding this comment.
For consistency and better source readability, it's better to use Markdown syntax for links instead of raw HTML <a> tags. 1
| Get world-class support through our support portal, <a href="mailto:[email protected]">email</a>, chat, or video conferencing. | |
| Get world-class support through our support portal, [email](mailto:[email protected]), chat, or video conferencing. |
Style Guide References
Footnotes
-
The style guide provides rules for Markdown usage, which should be followed for consistency. ↩
|
|
||
| - TiDB Cloud Serverless (renamed to Starter) | ||
|
|
||
| {{{ .starter }}} is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling MySQL-compatible database and offers a generous free quota and consumption based billing once free limits are exceeded. |
There was a problem hiding this comment.
The term "consumption based" should be hyphenated when used as a compound adjective before a noun ("billing"). 1
| {{{ .starter }}} is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling MySQL-compatible database and offers a generous free quota and consumption based billing once free limits are exceeded. | |
| {{{ .starter }}} is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling MySQL-compatible database and offers a generous free quota and consumption-based billing once free limits are exceeded. |
Style Guide References
Footnotes
-
The style guide requires correcting grammar and punctuation mistakes. ↩
|
|
||
| - Your VPC | ||
|
|
||
| You can connect to your TiDB cluster via private endpoint connection or VPC peering connection. Refer to [Set Up Private Endpoint Connections](/tidb-cloud/set-up-private-endpoint-connections.md) or [Set up VPC Peering Connection](/tidb-cloud/set-up-vpc-peering-connections.md) for details. |
There was a problem hiding this comment.
The phrase "Refer to" is a bit imperative. A more neutral phrasing like "For details, see..." is generally preferred in technical documentation. 1
| You can connect to your TiDB cluster via private endpoint connection or VPC peering connection. Refer to [Set Up Private Endpoint Connections](/tidb-cloud/set-up-private-endpoint-connections.md) or [Set up VPC Peering Connection](/tidb-cloud/set-up-vpc-peering-connections.md) for details. | |
| You can connect to your TiDB cluster via private endpoint connection or VPC peering connection. For details, see [Set Up Private Endpoint Connections](/tidb-cloud/set-up-private-endpoint-connections.md) or [Set up VPC Peering Connection](/tidb-cloud/set-up-vpc-peering-connections.md). |
Style Guide References
Footnotes
-
The style guide promotes clarity and simplicity, and avoiding overly imperative language contributes to a better user experience. ↩
ti-chi-bot
bot
removed
the
missing-translation-status
lilin90
added
missing-translation-status
ti-chi-bot
bot
added
size/L
qiancai
changed the title
qiancai
changed the title
Co-authored-by: Grace Cai <[email protected]>
|
[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 |
ti-chi-bot
bot
added
size/M
|
@qqqdan: The following test failed, say
Full PR test history. Your PR dashboard. 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. I understand the commands that are listed here. |
| - For Google Cloud Marketplace users, you can also sign up through Google Cloud Marketplace. To do that, search for `TiDB Cloud` in [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. | ||
|
|
||
| </CustomContent> | ||
|
|
|
|
||
| 2. On the **TiDB Instances** page, click **Create Instance**. | ||
| 3. Enter a name for your TiDB Cloud Premium instance. | ||
|
|
3 participants
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?