-
Notifications
You must be signed in to change notification settings - Fork 709
cloud: add docs for the My TiDB Page #22541
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
qiancai
merged 26 commits into
pingcap:feature/preview-one-console
from
qiancai:add-mytidb-intro
Apr 13, 2026
Merged
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
08e9d9f
add docs for the My TiDB Page
qiancai a01a9c1
Apply suggestions from code review
qiancai 73ad997
Merge branch 'feature/preview-one-console' into add-mytidb-intro
qiancai 1f9f85f
Update my-tidb.md
qiancai 3868e5c
update project related descriptions
qiancai 9033285
update steps about creating projects
qiancai e4e8b98
Update tidb-cloud-encrypt-cmek-azure.md
qiancai 46feba5
update security-concepts.md
qiancai 45ef368
added instructions for moving a TiDB X instance
qiancai 0fd28e4
Update manage-user-access.md
qiancai 7c88a9d
Update tidb-cloud-billing.md
qiancai 14ebaad
fix broken links and update glossary
qiancai 6372678
fix two broken links
qiancai a8276d8
Fix minor grammatical issues and improve clarity in multiple TiDB Clo…
qiancai 0d60d81
Apply suggestions from code review
qiancai 4580afc
fix typo
qiancai 147692c
Merge branch 'add-mytidb-intro' of github.com:qiancai/docs into add-m…
qiancai 62915d6
update project type descriptions and show premium only in Customcontent
qiancai d7b56fb
Apply suggestions from code review
qiancai 50a1066
rename my-tidb.md to manage-projects-and-resources.md
qiancai ed73a3e
glossary: add "Premium" to the project definition
qiancai 1204e62
Apply suggestions from code review
qiancai 2fdb04d
wrap premium info in the custom content
qiancai 2356480
wrap premium info in the CustomContent tag
qiancai 5b37c8e
Merge branch 'feature/preview-one-console' into add-mytidb-intro
qiancai 2d1a743
fix a broken link
qiancai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| title: Use the My TiDB Page | ||
| summary: Learn how to use the My TiDB Page to manage your TiDB resources and projects. | ||
|
qiancai marked this conversation as resolved.
Outdated
|
||
| --- | ||
|
|
||
| # Use the My TiDB Page to manage your TiDB resources and projects | ||
|
qiancai marked this conversation as resolved.
Outdated
|
||
|
|
||
| In the [TiDB Cloud console](https://tidbcloud.com/), [**My TiDB**](https://tidbcloud.com/tidbs) is a centralized page for all TiDB resources and projects that you can access within the current organization, helping you easily discover, access, and manage your TiDB resources. | ||
|
|
||
| ## What are TiDB resources and projects? | ||
|
qiancai marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## TiDB resources | ||
|
qiancai marked this conversation as resolved.
Outdated
|
||
|
|
||
| In TiDB Cloud, a TiDB resource is a manageable TiDB deployment unit. It can be one of the following: | ||
|
|
||
| - A {{{ .starter }}}, {{{ .essential }}}, or {{{ .premium }}} [instance](/tidb-cloud/tidb-cloud-glossary.md#instance) | ||
| - A {{{ .dedicated }}} [cluster](/tidb-cloud/tidb-cloud-glossary.md#cluster) | ||
|
|
||
| ## TiDB projects | ||
|
qiancai marked this conversation as resolved.
Outdated
|
||
|
|
||
| In TiDB Cloud, you can use [projects](/tidb-cloud/tidb-cloud-glossary.md#project) to group and manage your TiDB resources. | ||
|
qiancai marked this conversation as resolved.
Outdated
|
||
|
|
||
| - For {{{ .starter }}}, Essential, and Premium instances, projects are optional, which means you can either group these instances in a project or keep these instances at the organization level. | ||
|
qiancai marked this conversation as resolved.
Outdated
|
||
| - For {{{ .dedicated }}} clusters, projects are required. | ||
|
|
||
| ## Create TiDB resources | ||
|
|
||
| To create a TiDB resource, go to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click **Create Resource** in the upper-right corner. | ||
|
|
||
| For more information, see the following documents: | ||
|
|
||
| - [Create a {{{ .starter }}} or Essential Instance](/tidb-cloud/starter/create-tidb-cluster-serverless.md) | ||
| - [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md) | ||
| - [Create a TiDB Cloud Dedicated Cluster](/tidb-cloud/create-tidb-cluster.md) | ||
|
|
||
| ## View and manage TiDB resources | ||
|
|
||
| By default, the [**My TiDB**](https://tidbcloud.com/tidbs) page shows a list of all resources within your current organization that you have permission to access. | ||
|
|
||
| - To open the overview page of a TiDB resource, click the name of the target resource. | ||
| - To perform quick actions on a TiDB resource, such as deleting, renaming, and importing data, click **...** in the row of the target resource. | ||
| - If your organization has many instances or clusters, you can use the filters at the top of the page to quickly find what you need. | ||
|
Check warning on line 42 in tidb-cloud/my-tidb.md
|
||
|
|
||
| If you want to view your resources hierarchically by project, click the folder icon above the resource list to switch to the Project view | ||
|
qiancai marked this conversation as resolved.
Outdated
|
||
|
|
||
| - TiDB instances that do not belong to any project are displayed in a default folder named `Global instances - in [Your Org Name]`. | ||
| - TiDB instances that belong to specific projects are displayed in their corresponding project folders. | ||
| - TiDB Cloud Dedicated clusters are displayed in their corresponding project folders. These folders have a **D** in the folder icon to identify the **Dedicated** project type. | ||
|
|
||
| For more information about project types, see [Project types](/tidb-cloud/tidb-cloud-glossary.md#project-types). | ||
|
|
||
| ## Create TiDB projects | ||
|
|
||
| To create a new project, click **...** in the upper-right corner, and then click **Create Project**. For more information, see [Create a project](/tidb-cloud/manage-user-access.md#create-a-project). | ||
|
|
||
| You can also create a project when creating TiDB resources. For more information, see the following documents: | ||
|
|
||
| - [Create a {{{ .starter }}} or Essential Instance](/tidb-cloud/starter/create-tidb-cluster-serverless.md) | ||
| - [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md) | ||
| - [Create a TiDB Cloud Dedicated Cluster](/tidb-cloud/create-tidb-cluster.md) | ||
|
|
||
| ## Manage TiDB projects | ||
|
|
||
| In the Project view, you can click **...** in the row of the target project to perform quick actions on the project, such as renaming the project or inviting members to the project. | ||
|
qiancai marked this conversation as resolved.
Outdated
|
||
|
|
||
| For **Dedicated** projects, you can also click the gear icon in the row of the target project to access more project management operations, such as managing networks, alert subscriptions, and project members. | ||
|
|
||
| For more information, see [Manage project access](/tidb-cloud/manage-user-access.md) | ||
|
qiancai marked this conversation as resolved.
Outdated
|
||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.