[WIP] cloud: add docs for the My TiDB Page#22541
[WIP] cloud: add docs for the My TiDB Page#22541qiancai wants to merge 1 commit intopingcap:feature/preview-one-consolefrom
Conversation
ti-chi-bot
bot
added
the
do-not-merge/work-in-progress
|
[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
the
missing-translation-status
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 introduces new documentation for the 'My TiDB Page' in TiDB Cloud, aiming to centralize information on resource and project management. It ensures that users can easily find and understand how to navigate and utilize this core feature. The changes also include necessary updates to the glossary to define related terminology, providing a more consistent and clear documentation experience. 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
Activity
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
|
ti-chi-bot
bot
added
the
size/L
![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 'My TiDB' page, including a new documentation file and updates to the glossary. The changes are a good start. I've provided several suggestions to improve consistency, grammar, and adherence to the documentation style guide, focusing on heading structure, use of terminology, and writing style. All suggestions are minor and aim to enhance the clarity and professionalism of the documentation.
Note: Security Review has been skipped due to the limited scope of the PR.
| summary: Learn how to use the My TiDB Page to manage your TiDB resources and projects. | ||
| --- | ||
|
|
||
| # Use the My TiDB Page to manage your TiDB resources and projects |
There was a problem hiding this comment.
According to the repository's style guide, headings should use sentence case. Please update this heading accordingly.
| # Use the My TiDB Page to manage your TiDB resources and projects | |
| # Use the My TiDB page to manage your TiDB resources and projects |
References
- Use sentence case for headings (e.g.,
## Configure the cluster). (link)
|
|
||
| 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? |
There was a problem hiding this comment.
To improve the document's structure and heading hierarchy, I suggest renaming this heading. The following sections, "TiDB resources" and "TiDB projects," can then be updated to level 3 subheadings.
| ## What are TiDB resources and projects? | |
| ## TiDB resources and projects |
References
- Use proper heading hierarchy (no jumping from
##to####). Adhering to a logical heading structure improves readability. (link)
|
|
||
| ## What are TiDB resources and projects? | ||
|
|
||
| ## TiDB resources |
There was a problem hiding this comment.
To align with the suggested heading hierarchy improvement, please change this to a level 3 heading.
| ## TiDB resources | |
| ### TiDB resources |
References
- Use proper heading hierarchy (no jumping from
##to####). Adhering to a logical heading structure improves readability. (link)
| - 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 |
There was a problem hiding this comment.
To align with the suggested heading hierarchy improvement, please change this to a level 3 heading.
| ## TiDB projects | |
| ### TiDB projects |
References
- Use proper heading hierarchy (no jumping from
##to####). Adhering to a logical heading structure improves readability. (link)
|
|
||
| In TiDB Cloud, you can use [projects](/tidb-cloud/tidb-cloud-glossary.md#project) to group and manage your TiDB resources. | ||
|
|
||
| - 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. |
There was a problem hiding this comment.
For consistency and to ensure correct rendering, please use the variable format for Essential and Premium.
| - 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. | |
| - 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. |
References
- Use consistent terminology. (link)
|
|
||
| ### Instance | ||
|
|
||
| An instance is a [TiDB X](/tidb-cloud/tidb-x-architecture.md) cloud deployment that represents a service-oriented TiDB offering. With this deployment model, users do not need to manage or understand the underlying cluster topology. |
There was a problem hiding this comment.
The style guide recommends writing in the second person ("you"). Please update the sentence accordingly.
| An instance is a [TiDB X](/tidb-cloud/tidb-x-architecture.md) cloud deployment that represents a service-oriented TiDB offering. With this deployment model, users do not need to manage or understand the underlying cluster topology. | |
| An instance is a [TiDB X](/tidb-cloud/tidb-x-architecture.md) cloud deployment that represents a service-oriented TiDB offering. With this deployment model, you do not need to manage or understand the underlying cluster topology. |
References
- Write in second person ("you") when addressing users. (link)
| In TiDB Cloud product options, {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances use this deployment method. | ||
|
|
||
| Among TiDB Cloud plans, {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances use this deployment model. |
There was a problem hiding this comment.
These two sentences are repetitive. The style guide advises avoiding repetition. Please remove the redundant sentence to make the content more concise.
| In TiDB Cloud product options, {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances use this deployment method. | |
| Among TiDB Cloud plans, {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances use this deployment model. | |
| Among TiDB Cloud plans, {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances use this deployment model. |
References
- Avoid unnecessary words and repetition. (link)
| Based on the projects created by the organization, resources such as personnel, instances, and networks can be managed separately according to projects, and resources between projects do not interfere with each other. | ||
| In TiDB Cloud, you can use projects to group and manage your TiDB resources. | ||
|
|
||
| - 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. |
There was a problem hiding this comment.
For consistency and to ensure correct rendering, please use the variable format for Essential and Premium.
| - 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. | |
| - 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. |
References
- Use consistent terminology. (link)
|
|
||
| - TiDB X project: this is the default project type when you create a project on the [My TiDB](/tidb-cloud/my-tidb.md) page. In this type of project, you can only add {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances. | ||
| - TiDB Dedicated project: this project type is used only for {{{ .dedicated }}} clusters. In this type of project, you can only add {{{ .dedicated }}} clusters. Within your organization, settings and access controls such as networks, maintenance, alert subscriptions, and encryption access can be managed separately by project, and configurations in different projects do not affect each other. | ||
| - TiDB virtual project: this is a virtual project. It is not displayed in the [TiDB Cloud console](https://tidbcloud.com/) and does not provide any management capabilities. Its acts a virtual container for {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances that do not belong to any project, so that these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. |
There was a problem hiding this comment.
There's a small grammatical error here. It should be "It acts as...".
| - TiDB virtual project: this is a virtual project. It is not displayed in the [TiDB Cloud console](https://tidbcloud.com/) and does not provide any management capabilities. Its acts a virtual container for {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances that do not belong to any project, so that these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. | |
| - TiDB virtual project: this is a virtual project. It is not displayed in the [TiDB Cloud console](https://tidbcloud.com/) and does not provide any management capabilities. It acts as a virtual container for {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances that do not belong to any project, so that these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. |
References
- Correct English grammar, spelling, and punctuation mistakes, if any. (link)
|
|
||
| A TiDB resource is a manageable TiDB deployment unit. It can be one of the following: | ||
|
|
||
| - A {{{ .starter }}}, {{{ .essential }}}, or {{{ .premium }}} [instance](#instance) |
There was a problem hiding this comment.
There's an extra space in {{{ .premium }}}. Please remove it for consistency.
| - A {{{ .starter }}}, {{{ .essential }}}, or {{{ .premium }}} [instance](#instance) | |
| - A {{{ .starter }}}, {{{ .essential }}}, or {{{ .premium }}} [instance](#instance) |
References
- Correct English grammar, spelling, and punctuation mistakes, if any. (link)
|
@qiancai: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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. I understand the commands that are listed here. |
1 participant
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?