tidb-cloud: add the Features doc #22166
Conversation
ti-chi-bot
bot
added
the
missing-translation-status
Summary of ChangesHello @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 introduces a crucial new documentation page that clearly outlines the feature set available for each TiDB Cloud plan: Starter, Essential, and Dedicated. This addition aims to enhance user understanding of plan capabilities, ensuring they can easily identify which features are supported by their chosen tier. The corresponding navigation menus have also been refined to integrate this new resource seamlessly and improve overall clarity. Highlights
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 introduces a new 'Features' documentation page that provides a clear comparison of feature availability across different TiDB Cloud plans. The changes also include updates to the table of contents in several files to link to this new page. My review focuses on improving the clarity and consistency of the new markdown file. I've suggested minor formatting adjustments to align with best practices, such as removing trailing whitespace, standardizing HTML tags, and ensuring the file ends with a newline.
tidb-cloud/features.md
Outdated
| <tr> | ||
| <td>Data Migration (using the TiDB Cloud console)<br></td> | ||
| <td>❌<br></td> | ||
| <td>✅ <br/>(Private preview)</td> |
There was a problem hiding this comment.
This file uses both <br> and <br/>. For consistency and to adhere to HTML5 standards, please use <br> throughout the document. This will improve readability and maintainability.
| <td>✅ <br/>(Private preview)</td> | |
| <td>✅ <br>(Private preview)</td> |
References
- The style guide requires consistency. Using a single style for break tags improves readability and maintainability. (link)
qiancai
force-pushed
the
features-doc
branch
from
5a3924c to
f3b80d5
Compare
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
[LGTM Timeline notifier]Timeline:
|
@qiancai Can we hard-coded the background color for the first column? As it looks a bit weird now and might raise some unnecessary confusions. |
Hi @likidu, thanks for the advice. I've changed the font size of words like public preview to show them in one line. Here is the latest doc preview link: https://pr.pingcap-docsite-preview.pages.dev/tidbcloud/features/ 
|
ti-chi-bot
bot
added
size/XL
qiancai
force-pushed
the
features-doc
branch
from
d67d3e5 to
37d88f7
Compare
Yes, here is the latest version with the background color hard-coded as white for the first column. 
|
| </tr> | ||
| <tr> | ||
| <td rowspan="7" style="background-color: white;">Security</td> | ||
| <td>Private endpoint</td> |
There was a problem hiding this comment.
Private Endpoint & VPC peering should belong to "Connection".
Connection:
- Public Endpoint: all support
- Private Endpoint: all suppport
- VPC Peering: only Dedicated.
There was a problem hiding this comment.
Private endpoint & VPC peering also belong to security, so it's reasonable to put them in Security, especially when we want to emphasize security.
lilin90
removed
the
do-not-merge/hold
|
/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
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
5 participants
What is changed, added or deleted? (Required)
Add a doc to introduce the feature support status for different TiDB Cloud plans, including TiDB Cloud Starter, TiDB Cloud Essential, and TiDB Cloud Dedicated.
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?