cloud: update docs for one console#22744
Merged
ti-chi-bot[bot] merged 11 commits intorelease-8.5from Apr 14, 2026
Merged
Conversation
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Aolin <aolinz@outlook.com>
|
Skipping CI for Draft Pull Request. |
ti-chi-bot
bot
added
the
do-not-merge/work-in-progress
16 tasks
ti-chi-bot
bot
added
area/develop
ti-chi-bot
bot
removed
the
do-not-merge/work-in-progress
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the TiDB Cloud documentation to reflect a terminology shift from 'clusters' to 'instances' for Starter, Essential, and Premium plans, while also updating navigation instructions to the new 'My TiDB' page. It introduces a new guide for managing projects and resources and updates IAM documentation to include instance-level roles. The review feedback focuses on improving document maintainability by replacing raw SVG code with text descriptions and refining the text for better grammar, clarity, and conciseness.
|
|
||
| - If you have [loaded the existing data](#load-existing-data-optional) using Dumpling, select **Start replication from a specific TSO** and fill in the TSO that you get from Dumpling exported metadata files. | ||
| - If you do not have any data in the upstream TiDB <CustomContent plan="dedicated">cluster</CustomContent><CustomContent plan="premium">instance</CustomContent>, select **Start replication from now on**. | ||
| - If you do not have any data in the upstream TiDB , select **Start replication from now on**. |
Contributor
There was a problem hiding this comment.
There is an extra space before the comma, and the term following "TiDB" seems to have been accidentally removed during the update. Please correct the punctuation and consider if a term like "source" or "database" is needed for clarity.
Suggested change
| - If you do not have any data in the upstream TiDB , select **Start replication from now on**. | |
| - If you do not have any data in the upstream TiDB, select **Start replication from now on**. |
References
- Correct English grammar, spelling, and punctuation mistakes. (link)
| 2. In the project view, locate your target project, and then manage it as follows: | ||
|
|
||
| - For both TiDB X and TiDB Dedicated projects, you can click **...** in the row of the target project to perform quick actions on a project, such as renaming the project or inviting members to the project. For more information, see [Manage project access](/tidb-cloud/manage-user-access.md). | ||
| - For TiDB Dedicated projects, you can also click the <svg width="1em" height="1em" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" stroke-width="1.5" class="tiui-icon Settings02 " style="color: var(--mantine-color-carbon-7); width: calc(1rem * var(--mantine-scale)); height: calc(1rem * var(--mantine-scale));"><path d="M6.26338 12.9141L6.65301 13.7904C6.76884 14.0513 6.95786 14.2729 7.19716 14.4284C7.43646 14.584 7.71575 14.6668 8.00116 14.6667C8.28657 14.6668 8.56586 14.584 8.80516 14.4284C9.04446 14.2729 9.23348 14.0513 9.34931 13.7904L9.73894 12.9141C9.87764 12.6032 10.1109 12.3439 10.4056 12.1734C10.7021 12.0023 11.0452 11.9295 11.3856 11.9652L12.3389 12.0667C12.6227 12.0967 12.9091 12.0438 13.1634 11.9143C13.4177 11.7848 13.6289 11.5843 13.7715 11.3371C13.9143 11.0901 13.9823 10.8069 13.9674 10.522C13.9524 10.237 13.855 9.96258 13.6871 9.73189L13.1226 8.95634C12.9217 8.67813 12.8143 8.34325 12.816 8.00004C12.8159 7.65777 12.9243 7.32427 13.1256 7.04745L13.69 6.27189C13.858 6.04121 13.9553 5.76675 13.9703 5.48182C13.9853 5.19689 13.9173 4.91373 13.7745 4.66671C13.6319 4.41953 13.4206 4.21903 13.1664 4.08953C12.9121 3.96002 12.6257 3.90706 12.3419 3.93708L11.3886 4.03856C11.0481 4.07431 10.7051 4.00145 10.4086 3.83041C10.1133 3.65888 9.87995 3.39828 9.7419 3.08597L9.34931 2.20967C9.23348 1.94882 9.04446 1.72718 8.80516 1.57164C8.56586 1.4161 8.28657 1.33333 8.00116 1.33337C7.71575 1.33333 7.43646 1.4161 7.19716 1.57164C6.95786 1.72718 6.76884 1.94882 6.65301 2.20967L6.26338 3.08597C6.12533 3.39828 5.89196 3.65888 5.59672 3.83041C5.30019 4.00145 4.95716 4.07431 4.61672 4.03856L3.66042 3.93708C3.37664 3.90706 3.09024 3.96002 2.83596 4.08953C2.58168 4.21903 2.37043 4.41953 2.22783 4.66671C2.08504 4.91373 2.01701 5.19689 2.032 5.48182C2.04699 5.76675 2.14435 6.04121 2.31227 6.27189L2.87671 7.04745C3.07801 7.32427 3.18641 7.65777 3.18634 8.00004C3.18641 8.34232 3.07801 8.67581 2.87671 8.95263L2.31227 9.72819C2.14435 9.95887 2.04699 10.2333 2.032 10.5183C2.01701 10.8032 2.08504 11.0863 2.22783 11.3334C2.37057 11.5804 2.58185 11.7808 2.83609 11.9103C3.09034 12.0398 3.37666 12.0928 3.66042 12.063L4.61375 11.9615C4.9542 11.9258 5.29723 11.9986 5.59375 12.1697C5.8901 12.3407 6.12456 12.6014 6.26338 12.9141Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="inherit"></path><path d="M7.99997 10C9.10454 10 9.99997 9.10461 9.99997 8.00004C9.99997 6.89547 9.10454 6.00004 7.99997 6.00004C6.8954 6.00004 5.99997 6.89547 5.99997 8.00004C5.99997 9.10461 6.8954 10 7.99997 10Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="inherit"></path></svg> icon in the row of the target project to manage settings, such as networking, maintenance, alert subscriptions, and encryption access, for {{{ .dedicated }}} clusters by project. |
Contributor
There was a problem hiding this comment.
Avoid embedding raw SVG code directly in the documentation source files as it makes the Markdown difficult to read and maintain. Consider using a text description (e.g., "the settings icon") or a dedicated component if available. Additionally, "by project" is redundant in this context.
Suggested change
| - For TiDB Dedicated projects, you can also click the <svg width="1em" height="1em" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" stroke-width="1.5" class="tiui-icon Settings02 " style="color: var(--mantine-color-carbon-7); width: calc(1rem * var(--mantine-scale)); height: calc(1rem * var(--mantine-scale));"><path d="M6.26338 12.9141L6.65301 13.7904C6.76884 14.0513 6.95786 14.2729 7.19716 14.4284C7.43646 14.584 7.71575 14.6668 8.00116 14.6667C8.28657 14.6668 8.56586 14.584 8.80516 14.4284C9.04446 14.2729 9.23348 14.0513 9.34931 13.7904L9.73894 12.9141C9.87764 12.6032 10.1109 12.3439 10.4056 12.1734C10.7021 12.0023 11.0452 11.9295 11.3856 11.9652L12.3389 12.0667C12.6227 12.0967 12.9091 12.0438 13.1634 11.9143C13.4177 11.7848 13.6289 11.5843 13.7715 11.3371C13.9143 11.0901 13.9823 10.8069 13.9674 10.522C13.9524 10.237 13.855 9.96258 13.6871 9.73189L13.1226 8.95634C12.9217 8.67813 12.8143 8.34325 12.816 8.00004C12.8159 7.65777 12.9243 7.32427 13.1256 7.04745L13.69 6.27189C13.858 6.04121 13.9553 5.76675 13.9703 5.48182C13.9853 5.19689 13.9173 4.91373 13.7745 4.66671C13.6319 4.41953 13.4206 4.21903 13.1664 4.08953C12.9121 3.96002 12.6257 3.90706 12.3419 3.93708L11.3886 4.03856C11.0481 4.07431 10.7051 4.00145 10.4086 3.83041C10.1133 3.65888 9.87995 3.39828 9.7419 3.08597L9.34931 2.20967C9.23348 1.94882 9.04446 1.72718 8.80516 1.57164C8.56586 1.4161 8.28657 1.33333 8.00116 1.33337C7.71575 1.33333 7.43646 1.4161 7.19716 1.57164C6.95786 1.72718 6.76884 1.94882 6.65301 2.20967L6.26338 3.08597C6.12533 3.39828 5.89196 3.65888 5.59672 3.83041C5.30019 4.00145 4.95716 4.07431 4.61672 4.03856L3.66042 3.93708C3.37664 3.90706 3.09024 3.96002 2.83596 4.08953C2.58168 4.21903 2.37043 4.41953 2.22783 4.66671C2.08504 4.91373 2.01701 5.19689 2.032 5.48182C2.04699 5.76675 2.14435 6.04121 2.31227 6.27189L2.87671 7.04745C3.07801 7.32427 3.18641 7.65777 3.18634 8.00004C3.18641 8.34232 3.07801 8.67581 2.87671 8.95263L2.31227 9.72819C2.14435 9.95887 2.04699 10.2333 2.032 10.5183C2.01701 10.8032 2.08504 11.0863 2.22783 11.3334C2.37057 11.5804 2.58185 11.7808 2.83609 11.9103C3.09034 12.0398 3.37666 12.0928 3.66042 12.063L4.61375 11.9615C4.9542 11.9258 5.29723 11.9986 5.59375 12.1697C5.8901 12.3407 6.12456 12.6014 6.26338 12.9141Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="inherit"></path><path d="M7.99997 10C9.10454 10 9.99997 9.10461 9.99997 8.00004C9.99997 6.89547 9.10454 6.00004 7.99997 6.00004C6.8954 6.00004 5.99997 6.89547 5.99997 8.00004C5.99997 9.10461 6.8954 10 7.99997 10Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="inherit"></path></svg> icon in the row of the target project to manage settings, such as networking, maintenance, alert subscriptions, and encryption access, for {{{ .dedicated }}} clusters by project. | |
| - For TiDB Dedicated projects, you can also click the settings icon in the row of the target project to manage settings such as networking, maintenance, alert subscriptions, and encryption access for {{{ .dedicated }}} clusters. |
References
- Avoid unnecessary words and repetition. (link)
| > - Each project role has all the permissions of `Organization Viewer` by default. | ||
| > - If a user in your organization does not belong to any projects, the user does not have any project permissions. | ||
| > - For both TiDB X projects and TiDB Dedicated projects, project roles control access to resources in the project. For TiDB Dedicated projects, project roles also control Dedicated-specific project settings. | ||
| > - Project roles do not apply to the TiDB X virtual project because TiDB X virtual project does not provide any management capabilities. To manage RBAC for a specific TiDB X instance that are not grouped in any TiDB X project, use [instance roles](#instance-roles). |
Contributor
There was a problem hiding this comment.
Corrected the grammar ("instance that is not grouped") and used a pronoun to avoid repeating "TiDB X virtual project".
Suggested change
| > - Project roles do not apply to the TiDB X virtual project because TiDB X virtual project does not provide any management capabilities. To manage RBAC for a specific TiDB X instance that are not grouped in any TiDB X project, use [instance roles](#instance-roles). | |
| > - Project roles do not apply to the TiDB X virtual project because it does not provide any management capabilities. To manage RBAC for a specific TiDB X instance that is not grouped in any TiDB X project, use [instance roles](#instance-roles). |
| > - Instance roles apply only to {{{ .starter }}} and {{{ .essential }}}. TiDB Cloud Dedicated clusters do not support instance roles. | ||
| > - `Organization Owner` automatically has all permissions for all TiDB X instances in the organization. | ||
| > - Each instance role inherits all the permissions of the `Organization Viewer` role by default. | ||
| > - Project roles and instance roles are additive. A user can inherit access from a project role and also have a more specific role on an individual instance. |
Contributor
There was a problem hiding this comment.
Improved the sentence structure for better clarity.
Suggested change
| > - Project roles and instance roles are additive. A user can inherit access from a project role and also have a more specific role on an individual instance. | |
| > - Project roles and instance roles are additive. A user can inherit access from a project role and also be assigned a more specific role for an individual instance. |
| > **Note:** | ||
| > | ||
| > You can also [invite a user to your project](#invite-a-project-member) directly according to your need, which also makes the user your organization member. | ||
| > You can also [invite a user to your project](#invite-a-project-member) or [grant a user access to a TiDB X instance](#grant-access-to-a-tidb-x-instance) directly according to your need, which also makes the user your organization member. |
Contributor
There was a problem hiding this comment.
Removed unnecessary filler words to improve conciseness.
Suggested change
| > You can also [invite a user to your project](#invite-a-project-member) or [grant a user access to a TiDB X instance](#grant-access-to-a-tidb-x-instance) directly according to your need, which also makes the user your organization member. | |
| > You can also [invite a user to your project](#invite-a-project-member) or [grant a user access to a TiDB X instance](#grant-access-to-a-tidb-x-instance) directly, which also makes the user an organization member. |
References
- Avoid unnecessary words and repetition. (link)
| To invite a member to a project, take the following steps: | ||
|
|
||
| To create a new project, take the following steps: | ||
| 1. In the TiDB Cloud console, navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page of your organization, and then click the <svg width="1em" height="1em" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" stroke-width="1.5" class="tiui-icon Folder " style="width: calc(1.125rem * var(--mantine-scale)); height: calc(1.125rem * var(--mantine-scale));"><path d="M8.66671 4.66667L7.92301 3.17928C7.70898 2.7512 7.60195 2.53715 7.44229 2.38078C7.30109 2.24249 7.13092 2.13732 6.94409 2.07287C6.73282 2 6.49351 2 6.0149 2H3.46671C2.71997 2 2.3466 2 2.06139 2.14532C1.8105 2.27316 1.60653 2.47713 1.4787 2.72801C1.33337 3.01323 1.33337 3.3866 1.33337 4.13333V4.66667M1.33337 4.66667H11.4667C12.5868 4.66667 13.1469 4.66667 13.5747 4.88465C13.951 5.0764 14.257 5.38236 14.4487 5.75869C14.6667 6.18651 14.6667 6.74656 14.6667 7.86667V10.8C14.6667 11.9201 14.6667 12.4802 14.4487 12.908C14.257 13.2843 13.951 13.5903 13.5747 13.782C13.1469 14 12.5868 14 11.4667 14H4.53337C3.41327 14 2.85322 14 2.42539 13.782C2.04907 13.5903 1.74311 13.2843 1.55136 12.908C1.33337 12.4802 1.33337 11.9201 1.33337 10.8V4.66667Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="inherit"></path></svg> icon to go to the project view. |
Contributor
There was a problem hiding this comment.
Avoid using raw SVG code in the documentation. A text description of the icon is preferred for better maintainability.
Suggested change
| 1. In the TiDB Cloud console, navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page of your organization, and then click the <svg width="1em" height="1em" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" stroke-width="1.5" class="tiui-icon Folder " style="width: calc(1.125rem * var(--mantine-scale)); height: calc(1.125rem * var(--mantine-scale));"><path d="M8.66671 4.66667L7.92301 3.17928C7.70898 2.7512 7.60195 2.53715 7.44229 2.38078C7.30109 2.24249 7.13092 2.13732 6.94409 2.07287C6.73282 2 6.49351 2 6.0149 2H3.46671C2.71997 2 2.3466 2 2.06139 2.14532C1.8105 2.27316 1.60653 2.47713 1.4787 2.72801C1.33337 3.01323 1.33337 3.3866 1.33337 4.13333V4.66667M1.33337 4.66667H11.4667C12.5868 4.66667 13.1469 4.66667 13.5747 4.88465C13.951 5.0764 14.257 5.38236 14.4487 5.75869C14.6667 6.18651 14.6667 6.74656 14.6667 7.86667V10.8C14.6667 11.9201 14.6667 12.4802 14.4487 12.908C14.257 13.2843 13.951 13.5903 13.5747 13.782C13.1469 14 12.5868 14 11.4667 14H4.53337C3.41327 14 2.85322 14 2.42539 13.782C2.04907 13.5903 1.74311 13.2843 1.55136 12.908C1.33337 12.4802 1.33337 11.9201 1.33337 10.8V4.66667Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="inherit"></path></svg> icon to go to the project view. | |
| 1. In the TiDB Cloud console, navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page of your organization, and then click the folder icon to go to the project view. |
| 3. On the **Users** page, locate the row of the target member, click **...** in the row, and then click **Edit Role**. | ||
|
|
||
| 4. Enter a new project name. | ||
| 4. On the **Edit Role** dialog, locate the target project, and then click the <svg width="1em" height="1em" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" stroke-width="1.5" class="tiui-icon Trash01 " style="width: calc(1rem * var(--mantine-scale)); height: calc(1rem * var(--mantine-scale));"><path d="M10.6667 4.00004V3.46671C10.6667 2.71997 10.6667 2.3466 10.5213 2.06139C10.3935 1.8105 10.1895 1.60653 9.93865 1.4787C9.65344 1.33337 9.28007 1.33337 8.53333 1.33337H7.46667C6.71993 1.33337 6.34656 1.33337 6.06135 1.4787C5.81046 1.60653 5.60649 1.8105 5.47866 2.06139C5.33333 2.3466 5.33333 2.71997 5.33333 3.46671V4.00004M6.66667 7.66671V11M9.33333 7.66671V11M2 4.00004H14M12.6667 4.00004V11.4667C12.6667 12.5868 12.6667 13.1469 12.4487 13.5747C12.2569 13.951 11.951 14.257 11.5746 14.4487C11.1468 14.6667 10.5868 14.6667 9.46667 14.6667H6.53333C5.41323 14.6667 4.85318 14.6667 4.42535 14.4487C4.04903 14.257 3.74307 13.951 3.55132 13.5747C3.33333 13.1469 3.33333 12.5868 3.33333 11.4667V4.00004" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="inherit"></path></svg> icon. |
Contributor
There was a problem hiding this comment.
Removed the double space after "the" and replaced the raw SVG with a text description.
Suggested change
| 4. On the **Edit Role** dialog, locate the target project, and then click the <svg width="1em" height="1em" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" stroke-width="1.5" class="tiui-icon Trash01 " style="width: calc(1rem * var(--mantine-scale)); height: calc(1rem * var(--mantine-scale));"><path d="M10.6667 4.00004V3.46671C10.6667 2.71997 10.6667 2.3466 10.5213 2.06139C10.3935 1.8105 10.1895 1.60653 9.93865 1.4787C9.65344 1.33337 9.28007 1.33337 8.53333 1.33337H7.46667C6.71993 1.33337 6.34656 1.33337 6.06135 1.4787C5.81046 1.60653 5.60649 1.8105 5.47866 2.06139C5.33333 2.3466 5.33333 2.71997 5.33333 3.46671V4.00004M6.66667 7.66671V11M9.33333 7.66671V11M2 4.00004H14M12.6667 4.00004V11.4667C12.6667 12.5868 12.6667 13.1469 12.4487 13.5747C12.2569 13.951 11.951 14.257 11.5746 14.4487C11.1468 14.6667 10.5868 14.6667 9.46667 14.6667H6.53333C5.41323 14.6667 4.85318 14.6667 4.42535 14.4487C4.04903 14.257 3.74307 13.951 3.55132 13.5747C3.33333 13.1469 3.33333 12.5868 3.33333 11.4667V4.00004" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="inherit"></path></svg> icon. | |
| 4. On the **Edit Role** dialog, locate the target project, and then click the trash icon. |
References
- Correct English grammar, spelling, and punctuation mistakes. (link)
qiancai
changed the title
qiancai
added
translation/no-need
ti-chi-bot
bot
removed
the
missing-translation-status
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Oreoxmt
approved these changes
Apr 14, 2026
[LGTM Timeline notifier]Timeline:
|
Collaborator
Author
|
/test pull-verify |
Collaborator
Author
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Collaborator
Author
|
/retest |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is changed, added or deleted? (Required)
This PR merges all changes made on the preview-one-one branch:
instancewhere the UI now shows instance-level conceptsTiDB instancesWhich TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?