develop: add documents for TiDB Cloud Premium (#22533)#22798
develop: add documents for TiDB Cloud Premium (#22533)#22798ti-chi-bot wants to merge 5 commits intopingcap:masterfrom
Conversation
ti-chi-bot
added
area/develop
![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 support for a new TiDB Cloud instance type across multiple documentation files, including GUI connection guides and sample application tutorials. The updates involve adding specific connection instructions and environment variable configurations for the new instance. Review feedback highlights technical inconsistencies regarding SSL settings, suggests using active voice for better clarity, and recommends grammatical corrections for consistency.
| | User | `{user}` | | ||
| | Password | `{password}` | | ||
|
|
||
| - On the **SSH/SSL** tab, clear the **Use SSL** checkbox. |
There was a problem hiding this comment.
There is a technical inconsistency here. Step 6 (line 97) mentions downloading a CA certificate, but this step instructs users to clear the Use SSL checkbox. For public endpoints on a cloud service, SSL should be enabled and configured using the provided CA certificate for security.
| - On the **SSH/SSL** tab, clear the **Use SSL** checkbox. | |
| - On the **SSH/SSL** tab, select the **Use SSL** checkbox and specify the CA certificate path in the **CA file** field. |
References
- Ensure technical accuracy and terminology consistency. (link)
| "TIDB_PORT": "4000", | ||
| "TIDB_USER": "root", | ||
| "TIDB_PASSWORD": "{password}", | ||
| "TIDB_ENABLE_SSL": "false" |
There was a problem hiding this comment.
Technical inconsistency. Step 6 (line 130) mentions downloading a CA certificate, but the environment variable is set to false. For security on public endpoints, SSL should be enabled.
| "TIDB_ENABLE_SSL": "false" | |
| "TIDB_ENABLE_SSL": "true" |
References
- Ensure technical accuracy. (link)
| TIDB_PORT='4000' | ||
| TIDB_USER='{user}' # e.g. root | ||
| TIDB_PASSWORD='{password}' | ||
| TIDB_DB_NAME='test' |
There was a problem hiding this comment.
The example configuration for Premium is missing the CA_PATH environment variable, which is mentioned in Step 6 (line 135) and included in the Starter/Essential section (line 107). Adding it ensures completeness.
| TIDB_DB_NAME='test' | |
| TIDB_DB_NAME='test'\n CA_PATH='' |
References
- Ensure completeness and technical accuracy. (link)
|
|
||
| 4. In the left navigation pane, click **Overview** to return to the instance overview page. | ||
|
|
||
| 5. Click **Connect** in the upper-right corner. A connection dialog is displayed. |
There was a problem hiding this comment.
Use active voice to improve clarity and follow the technical writing principles.
| 5. Click **Connect** in the upper-right corner. A connection dialog is displayed. | |
| 5. Click **Connect** in the upper-right corner. The connection dialog appears. |
References
- Avoid passive voice overuse and prefer active voice. (link)
| | Password | `{password}` | | ||
|
|
||
| - On the **SSH/SSL** tab, clear the **Use SSL** checkbox. | ||
| - If a **Download missing driver files** warning is displayed, click **Download** to acquire the driver files. |
There was a problem hiding this comment.
Use active voice and address the user directly as per the style guide.
| - If a **Download missing driver files** warning is displayed, click **Download** to acquire the driver files. | |
| - If you see a **Download missing driver files** warning, click **Download** to acquire the driver files. |
References
- Write in second person ("you") when addressing users and avoid passive voice. (link)
|
|
||
| 8. In the **Setup New Connection** dialog, configure the following connection parameters: | ||
|
|
||
| - **Connection Name**: give this connection a meaningful name. |
There was a problem hiding this comment.
Capitalize the first word of the description in the list for consistency and better grammar.
References
- Correct English grammar, spelling, and punctuation mistakes. (link)
3 participants
This is an automated cherry-pick of #22533
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?