*: update premium for preview#21789
Conversation
|
[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 |
There was a problem hiding this comment.
Summary of Changes
Hello @lilin90, 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 systematically updates the TiDB Cloud documentation to incorporate the "Premium" cluster tier. By modifying references across a wide array of guides—from connection instructions for various tools and programming languages to backup, restore, security, and data migration procedures—the PR ensures that users are presented with accurate and comprehensive information regarding all available TiDB Cloud service tiers. This update aims to maintain consistency and clarity in the documentation for all users.
Highlights
- Documentation Update: The pull request updates numerous documentation files to include the "Premium" tier alongside the existing "Starter" and "Essential" tiers.
- Broad Impact: These changes are applied across various guides, including those for connecting to TiDB clusters using different GUIs and programming languages, backup and restore procedures, security configurations, and data import/export processes.
- Consistency: The updates ensure consistent terminology and coverage of all TiDB Cloud service tiers throughout the documentation.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| 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 pull request 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. 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
-
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 multiple documentation files to include the 'Premium' plan alongside 'Starter' and 'Essential'. The changes are mostly correct, but I've found several places where the update was incomplete, leading to inconsistencies in titles, summaries, and body text. My review comments provide suggestions to fix these for overall document consistency.
| --- | ||
| title: Back Up and Restore Data on {{{ .starter }}} or Essential | ||
| title: Back Up and Restore Data on {{{ .starter }}}, Essential, or Premium | ||
| summary: Learn how to back up and restore your {{{ .starter }}} or {{{ .essential }}} clusters. | ||
| aliases: ['/tidbcloud/restore-deleted-tidb-cluster'] | ||
| --- | ||
|
|
||
| # Back Up and Restore Data on {{{ .starter }}} or Essential | ||
| # Back Up and Restore Data on {{{ .starter }}}, Essential, or Premium | ||
|
|
||
| This document describes how to back up and restore your data on {{{ .starter }}} or {{{ .essential }}} clusters. |
There was a problem hiding this comment.
For consistency, please update the summary and the introductory sentence to include 'Premium'.
| --- | |
| title: Back Up and Restore Data on {{{ .starter }}} or Essential | |
| title: Back Up and Restore Data on {{{ .starter }}}, Essential, or Premium | |
| summary: Learn how to back up and restore your {{{ .starter }}} or {{{ .essential }}} clusters. | |
| aliases: ['/tidbcloud/restore-deleted-tidb-cluster'] | |
| --- | |
| # Back Up and Restore Data on {{{ .starter }}} or Essential | |
| # Back Up and Restore Data on {{{ .starter }}}, Essential, or Premium | |
| This document describes how to back up and restore your data on {{{ .starter }}} or {{{ .essential }}} clusters. | |
| --- | |
| title: Back Up and Restore Data on {{{ .starter }}}, Essential, or Premium | |
| summary: Learn how to back up and restore your {{{ .starter }}}, {{{ .essential }}}, or Premium clusters. | |
| aliases: ['/tidbcloud/restore-deleted-tidb-cluster'] | |
| --- | |
| # Back Up and Restore Data on {{{ .starter }}}, Essential, or Premium | |
| This document describes how to back up and restore your data on {{{ .starter }}}, {{{ .essential }}}, or Premium clusters. |
| --- | ||
| title: Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints | ||
| title: Configure {{{ .starter }}}, Essential, or Premium Firewall Rules for Public Endpoints | ||
| summary: Learn how to configure and manage firewall rules with public access to your {{{ .starter }}} or {{{ .essential }}} cluster securely. | ||
| --- | ||
|
|
||
| # Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints | ||
| # Configure {{{ .starter }}}, Essential, or Premium Firewall Rules for Public Endpoints | ||
|
|
||
| This document describes the public connectivity option for {{{ .starter }}} and {{{ .essential }}} clusters. You will learn key concepts for securely managing a cluster accessible via the internet. |
There was a problem hiding this comment.
For consistency, please update the summary and the introductory sentence to include 'Premium'.
| --- | |
| title: Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints | |
| title: Configure {{{ .starter }}}, Essential, or Premium Firewall Rules for Public Endpoints | |
| summary: Learn how to configure and manage firewall rules with public access to your {{{ .starter }}} or {{{ .essential }}} cluster securely. | |
| --- | |
| # Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints | |
| # Configure {{{ .starter }}}, Essential, or Premium Firewall Rules for Public Endpoints | |
| This document describes the public connectivity option for {{{ .starter }}} and {{{ .essential }}} clusters. You will learn key concepts for securely managing a cluster accessible via the internet. | |
| --- | |
| title: Configure {{{ .starter }}}, Essential, or Premium Firewall Rules for Public Endpoints | |
| summary: Learn how to configure and manage firewall rules with public access to your {{{ .starter }}}, {{{ .essential }}}, or Premium cluster securely. | |
| --- | |
| # Configure {{{ .starter }}}, Essential, or Premium Firewall Rules for Public Endpoints | |
| This document describes the public connectivity option for {{{ .starter }}}, {{{ .essential }}}, and Premium clusters. You will learn key concepts for securely managing a cluster accessible via the internet. |
| --- | ||
| title: Export Data from {{{ .starter }}} or Essential | ||
| title: Export Data from {{{ .starter }}}, Essential, or Premium | ||
| summary: Learn how to export data from {{{ .starter }}} or {{{ .essential }}} clusters. |
There was a problem hiding this comment.
| # Configure External Storage Access for {{{ .starter }}} or Essential | ||
| # Configure External Storage Access for {{{ .starter }}}, Essential, or Premium | ||
|
|
||
| If you want to import data from or export data to an external storage in a TiDB Cloud cluster, you need to configure cross-account access. This document describes how to configure access to an external storage for {{{ .starter }}} and {{{ .essential }}} clusters. |
There was a problem hiding this comment.
For consistency with the title, please also update this sentence to include 'Premium'.
| If you want to import data from or export data to an external storage in a TiDB Cloud cluster, you need to configure cross-account access. This document describes how to configure access to an external storage for {{{ .starter }}} and {{{ .essential }}} clusters. | |
| If you want to import data from or export data to an external storage in a TiDB Cloud cluster, you need to configure cross-account access. This document describes how to configure access to an external storage for {{{ .starter }}}, {{{ .essential }}}, and Premium clusters. |
| <div label="{{{ .starter }}} or Essential"> | ||
| <div label="{{{ .starter }}}, Essential, or Premium"> | ||
|
|
||
| For {{{ .starter }}} or {{{ .essential }}}, your clients can connect to clusters via public endpoint or private endpoint. |
There was a problem hiding this comment.
For consistency, please update this sentence to include 'Premium'.
| For {{{ .starter }}} or {{{ .essential }}}, your clients can connect to clusters via public endpoint or private endpoint. | |
| For {{{ .starter }}}, {{{ .essential }}}, or Premium, your clients can connect to clusters via public endpoint or private endpoint. |
| @@ -44,13 +44,13 @@ For {{{ .starter }}} or {{{ .essential }}}, your clients can connect to clusters | |||
| - To connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, refer to the following documents to set up a private endpoint first and deploy the replication instance in private subnets. | |||
There was a problem hiding this comment.
For consistency, please update this sentence to include 'Premium'.
| - To connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, refer to the following documents to set up a private endpoint first and deploy the replication instance in private subnets. | |
| - To connect to a {{{ .starter }}}, {{{ .essential }}}, or Premium cluster via private endpoint, refer to the following documents to set up a private endpoint first and deploy the replication instance in private subnets. |
| --- | ||
| title: Import Local Files to {{{ .starter }}} or Essential | ||
| title: Import Local Files to {{{ .starter }}}, Essential, or Premium | ||
| summary: Learn how to import local files to {{{ .starter }}} or {{{ .essential }}}. | ||
| --- | ||
|
|
||
| # Import Local Files to {{{ .starter }}} or Essential | ||
| # Import Local Files to {{{ .starter }}}, Essential, or Premium | ||
|
|
||
| You can import local files to {{{ .starter }}} or {{{ .essential }}} directly. It only takes a few clicks to complete the task configuration, and then your local CSV data will be quickly imported to your TiDB cluster. Using this method, you do not need to provide the cloud storage and credentials. The whole importing process is quick and smooth. |
There was a problem hiding this comment.
For consistency, please update the summary and the introductory sentence to include 'Premium'.
| --- | |
| title: Import Local Files to {{{ .starter }}} or Essential | |
| title: Import Local Files to {{{ .starter }}}, Essential, or Premium | |
| summary: Learn how to import local files to {{{ .starter }}} or {{{ .essential }}}. | |
| --- | |
| # Import Local Files to {{{ .starter }}} or Essential | |
| # Import Local Files to {{{ .starter }}}, Essential, or Premium | |
| You can import local files to {{{ .starter }}} or {{{ .essential }}} directly. It only takes a few clicks to complete the task configuration, and then your local CSV data will be quickly imported to your TiDB cluster. Using this method, you do not need to provide the cloud storage and credentials. The whole importing process is quick and smooth. | |
| --- | |
| title: Import Local Files to {{{ .starter }}}, Essential, or Premium | |
| summary: Learn how to import local files to {{{ .starter }}}, {{{ .essential }}}, or Premium. | |
| --- | |
| # Import Local Files to {{{ .starter }}}, Essential, or Premium | |
| You can import local files to {{{ .starter }}}, {{{ .essential }}}, or Premium directly. It only takes a few clicks to complete the task configuration, and then your local CSV data will be quickly imported to your TiDB cluster. Using this method, you do not need to provide the cloud storage and credentials. The whole importing process is quick and smooth. |
Updated documentation to consistently mention that various features and tables are not available on TiDB Cloud Starter, Essential, and Premium clusters, instead of only Starter and Essential. This improves clarity for users regarding feature support across all TiDB Cloud tiers.
[LGTM Timeline notifier]Timeline:
|
cacdf46
into
pingcap:feature/preview-premium
What is changed, added or deleted? (Required)
Updates premium for preview.
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?