[WIP] release-cloud: update steps according to the new nav pane #21159
Conversation
ti-chi-bot
bot
added
do-not-merge/work-in-progress
![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 @qiancai, 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 focuses on updating the TiDB Cloud documentation to match recent changes in the console's user interface, specifically the restructuring of the left navigation pane. The changes provide users with accurate instructions for accessing various features and settings within the updated console layout.
Highlights
- Navigation Updates: Updated documentation steps across numerous files to reflect changes in the TiDB Cloud console's left navigation pane. Many items previously accessed directly or via specific icons are now nested under new top-level menus like 'Data', 'Monitoring', and 'Settings'.
- Organization/Project Switching: Revised instructions for switching between organizations and projects, emphasizing the use of the drop-down box in the upper-left corner of the console.
- Page/Tab Naming Consistency: Ensured consistency in referring to console pages and tabs, often bolding the names (e.g., Metrics page, SQL Users tab).
- Refined Step-by-Step Guides: Adjusted specific step-by-step instructions for tasks like managing SQL users, configuring networking, importing/exporting data, and accessing billing/support features to align with the new navigation paths.
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 configureGemini 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 pull request updates several documentation files to reflect changes in the TiDB Cloud navigation pane and UI elements. The updates primarily involve revising procedural steps to guide users through the new interface. Overall, the changes enhance clarity and accuracy by aligning the documentation with the updated product UI.
ti-chi-bot
bot
added
the
area/develop
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
| @@ -69,7 +69,7 @@ To complete this tutorial, you need the following: | |||
|
|
|||
| ### Step 2. Set the environment | |||
|
|
|||
| 1. In the [TiDB Cloud console](https://console.tidb.io/signup?provider_source=alicloud), navigate to the [**Clusters**](https://console.tidb.io/clusters) page of your project, and then click the name of your target TiDB Cloud Starter cluster to go to its overview page. | |||
| 1. In the [TiDB Cloud console](https://console.tidb.io/signup?provider_source=alicloud), navigate to the [**Clusters**](https://console.tidb.io/project/clusters) page of your project, and then click the name of your target TiDB Cloud Starter cluster to go to its overview page. | |||
|
|
|||
| 2. On the overview page, click **Connect** in the upper-right corner, select `Serverless Driver` in the **Connect With** drop-down box, and then click **Generate Password** to create a random password. | |||
There was a problem hiding this comment.
| 2. On the overview page, click **Connect** in the upper-right corner, select `Serverless Driver` in the **Connect With** drop-down box, and then click **Generate Password** to create a random password. | |
| 2. On the overview page, click **Connect** in the upper-right corner, select `Serverless Driver` in the **Connect With** drop-down list, and then click **Generate Password** to create a random password. |
qiancai
added
translation/no-need
ti-chi-bot
bot
removed
the
missing-translation-status
|
[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 |
|
|
||
| 3. Click **Create New Project**. | ||
| 3. On the **Projects** page, click **Create New Project**. |
There was a problem hiding this comment.
| 3. On the **Projects** page, click **Create New Project**. | |
| 3. On the **Projects** page, click **Create New Project** in the upper-right corner. |
| 3. Under the **Payment Method** tab, click **Add a New Card**. | ||
| 1. In the [TiDB Cloud console](https://console.tidb.io/signup?provider_source=alicloud), 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 **Payment Method** tab, and then click **Add a New Card**. |
There was a problem hiding this comment.
| 3. On the **Billing** page, click the **Payment Method** tab, and then click **Add a New Card**. | |
| 3. On the **Billing** page, click the **Payment Methods** tab, and then click **Add a New Card**. |
| 4. Select a credit card in the credit card list, and click **Set as default**. | ||
| 1. In the [TiDB Cloud console](https://console.tidb.io/signup?provider_source=alicloud), 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 **Payment Method** tab. |
There was a problem hiding this comment.
| 3. On the **Billing** page, click the **Payment Method** tab. | |
| 3. On the **Billing** page, click the **Payment Methods** tab. |
[LGTM Timeline notifier]Timeline:
|
|
@awxxxxxx: 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. |
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?