*: clarify feature availability on Starter and Essential clusters (#21509) #21549
Conversation
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
ti-chi-bot
added
area/develop
|
@lilin90 This PR has conflicts, I have hold it. |
|
@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide. 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 ti-community-infra/tichi repository. |
![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 @ti-chi-bot, 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!
I've performed a comprehensive documentation update to enhance the accuracy of information regarding feature availability and compatibility across TiDB Cloud's Starter and Essential cluster tiers. The primary goal was to ensure that our documentation precisely reflects which features, INFORMATION_SCHEMA tables, and tutorials are applicable or not applicable to both Starter and Essential clusters, rather than just Starter. This change provides a more complete and reliable resource for users operating on these specific TiDB Cloud configurations.
Highlights
- Clarified Feature Unavailability: I've updated numerous documentation pages to accurately reflect that certain features and
INFORMATION_SCHEMAtables are unavailable not just on TiDB Cloud Starter clusters, but also on TiDB Cloud Essential clusters. This ensures consistency and correctness in our feature availability matrix. - Expanded Tutorial Compatibility: I've modified various tutorial and guide pages to explicitly include TiDB Cloud Essential clusters in their compatibility statements, often changing 'Starter' to 'Starter or Essential' in text and UI labels. This helps users of Essential clusters understand which guides apply to them.
- Refined Technical Notes for Essential Clusters: I've updated notes related to TLS connection requirements and system variable behaviors to specifically mention TiDB Cloud Essential clusters, ensuring that users on these tiers have precise information regarding operational aspects and limitations.
- Updated Vector Search Feature Availability: I've updated the documentation for vector search features to explicitly state their availability across TiDB Self-Managed, Starter, Essential, and Dedicated clusters, providing a clearer picture of where this advanced functionality can be utilized.
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 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 or fill out our survey 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 configure Gemini 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 a large number of documentation files to clarify that certain features and limitations apply to both TiDB Cloud Starter and Essential clusters, not just Starter clusters. The changes are generally correct and align with the PR's goal. However, a significant number of files contain unresolved merge conflicts, which must be addressed before this PR can be merged. I have added comments to each affected file with suggestions for resolving the conflicts.
Resolved merge conflict markers and updated documentation to consistently state that the vector search feature is available on TiDB Self-Managed, Starter, Essential, and TiDB Cloud Dedicated clusters, with version requirements clarified. This change ensures accurate and unified information across all vector search documentation pages.
The section describing the txn_scope system variable has been removed from the documentation. This variable is intended for internal use and is not recommended for users to set.
|
Note: This PR is ready for merging. |
lilin90
added
the
translation/done
|
/unhold |
ti-chi-bot
bot
removed
the
do-not-merge/hold
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lilin90 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 |
This is an automated cherry-pick of #21509
What is changed, added or deleted? (Required)
Updated documentation to indicate that various features and INFORMATION_SCHEMA tables are not available on both TiDB Cloud Starter and Essential clusters, instead of only Starter clusters. This change ensures accurate information about feature availability across different TiDB Cloud cluster tiers.
Note
This PR updated only those files outside the
./tidb-clouddirectory. For changes inside the./tidb-clouddirectory, see #21516.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?