feat: develop document for tidb cloud premium#22533
feat: develop document for tidb cloud premium#22533Icemap wants to merge 1 commit intofeature/preview-one-consolefrom
Conversation
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
area/develop
|
/cc @Oreoxmt |
Summary of ChangesHello, 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 enhances the documentation for TiDB Cloud Premium by integrating detailed connection instructions into existing guides for various GUI tools and sample applications. The changes aim to provide a seamless experience for users looking to connect their development environments and applications to TiDB Cloud Premium instances, covering setup steps from enabling public endpoints to configuring specific client-side connection parameters, including SSL settings where applicable. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
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
|
![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 documentation for the new TiDB Cloud Premium tier across various developer guides. The changes are generally well-executed and consistent. I've provided a few suggestions to enhance consistency in formatting and wording, ensuring the new content aligns perfectly with the existing documentation and style guidelines.
Note: Security Review has been skipped due to the limited scope of the PR.
| - **Connect using**: select **Server and Port**. | ||
| - **Server Address**: `{host}` | ||
| - **Port**: `{port}` | ||
| - **Database**: the database that you want to connect to. | ||
| - **Username**: `{user}` | ||
| - **Password mode**: select **SQLTools Driver Credentials**. | ||
| - In the **MySQL driver specific options** area, configure the following parameters: | ||
|
|
||
| - **Authentication Protocol**: select **default**. | ||
| - **SSL**: select **Disabled**. |
There was a problem hiding this comment.
To improve consistency with the {{{ .starter }}} section in this document, I suggest using parameter names (e.g., HOST) instead of placeholders (e.g., {host}) and bolding the UI options for clarity.
| - **Connect using**: select **Server and Port**. | |
| - **Server Address**: `{host}` | |
| - **Port**: `{port}` | |
| - **Database**: the database that you want to connect to. | |
| - **Username**: `{user}` | |
| - **Password mode**: select **SQLTools Driver Credentials**. | |
| - In the **MySQL driver specific options** area, configure the following parameters: | |
| - **Authentication Protocol**: select **default**. | |
| - **SSL**: select **Disabled**. | |
| - **Connect using**: select **Server and Port**. | |
| - **Server Address**: enter the `HOST` parameter from the connection dialog. | |
| - **Port**: enter the `PORT` parameter from the connection dialog. | |
| - **Database**: the database that you want to connect to. | |
| - **Username**: enter the `USERNAME` parameter from the connection dialog. | |
| - **Password mode**: select **SQLTools Driver Credentials**. | |
| - In the **MySQL driver specific options** area, configure the following parameters: | |
| - **Authentication Protocol**: select **default**. | |
| - **SSL**: select **Disabled**. |
References
- The style guide (line 34) recommends using backticks for options and paths. This suggestion also improves consistency with other parts of the document by using parameter names and bolding UI elements. (link)
|
|
||
| 4. Click **Overview** in the left panel to return to the overview page. | ||
|
|
||
| 5. Click **Connect** in the upper right corner. A connection dialog is displayed. In the connection dialog, select `Public` from the **Connection Type** drop-down list. |
There was a problem hiding this comment.
For consistency with other documentation files, upper right should be hyphenated.
| 5. Click **Connect** in the upper right corner. A connection dialog is displayed. In the connection dialog, select `Public` from the **Connection Type** drop-down list. | |
| 5. Click **Connect** in the upper-right corner. A connection dialog is displayed. In the connection dialog, select `Public` from the **Connection Type** drop-down list. |
References
- The style guide (line 20) recommends correcting spelling and punctuation mistakes. 'upper-right' is the consistent and correct form used across the documentation. (link)
ti-chi-bot
bot
removed
the
missing-translation-status
Oreoxmt
added
missing-translation-status
|
/cc @Mini256 |
2 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?