release-8.5: use a variable to refer to TiDB Cloud Serverless #21290
Conversation
ti-chi-bot
bot
added
area/develop
ti-chi-bot
bot
added
the
do-not-merge/work-in-progress
![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 @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 implements a significant terminology update within the documentation, replacing all instances of 'TiDB Cloud Serverless' with 'TiDB Cloud Starter'. This is a broad branding change affecting numerous guides, reference materials, and feature descriptions to align the documentation with the new product naming convention.
Highlights
- Terminology Update: The term 'TiDB Cloud Serverless' has been globally renamed to 'TiDB Cloud Starter' across various documentation files outside the
tidb-cloudfolder. - Documentation Consistency: This change ensures consistency in product naming throughout the documentation, affecting quick start guides, developer guides, GUI tool connection instructions, SQL statements, information schema tables, system variables, and vector search features.
- Version Specificity: The changes are specifically targeted for the
release-8.5branch, indicating a product branding update for this version.
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 is currently in preview and 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 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 correctly renames most instances of "TiDB Cloud Serverless" to "TiDB Cloud Starter". However, I've identified several areas where the changes are incomplete, leading to broken or inconsistent links. Specifically, many internal links have outdated URL anchors or file paths that still reference "serverless". I've provided detailed comments on a few examples that represent these recurring issues. Please address these to ensure the documentation remains consistent and navigable. Additionally, one external link's text was updated, which should be reverted to match the actual title of the linked content.
develop/dev-guide-create-table.md
Outdated
| @@ -292,7 +292,7 @@ ALTER TABLE `bookshop`.`ratings` SET TIFLASH REPLICA 1; | |||
|
|
|||
| > **Note:** | |||
| > | |||
| > If your cluster does not contain **TiFlash** nodes, this SQL statement will report an error: `1105 - the tiflash replica count: 1 should be less than the total tiflash server count: 0`. You can use [Build a TiDB Cloud Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-cloud-serverless-cluster) to create a TiDB Cloud Serverless cluster that includes **TiFlash**. | |||
| > If your cluster does not contain **TiFlash** nodes, this SQL statement will report an error: `1105 - the tiflash replica count: 1 should be less than the total tiflash server count: 0`. You can use [Build a TiDB Cloud Starter Cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-cloud-serverless-cluster) to create a TiDB Cloud Starter cluster that includes **TiFlash**. | |||
There was a problem hiding this comment.
This link appears to be broken. The anchor #step-1-create-a-tidb-cloud-serverless-cluster is no longer valid because the corresponding heading in develop/dev-guide-build-cluster-in-cloud.md has been updated to ## Step 1. Create a TiDB Cloud Starter cluster. Please update the anchor to #step-1-create-a-tidb-cloud-starter-cluster to fix the link. I've noticed this issue in other files as well, such as develop/dev-guide-tidb-crud-sql.md.
| > If your cluster does not contain **TiFlash** nodes, this SQL statement will report an error: `1105 - the tiflash replica count: 1 should be less than the total tiflash server count: 0`. You can use [Build a TiDB Cloud Starter Cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-cloud-serverless-cluster) to create a TiDB Cloud Starter cluster that includes **TiFlash**. | |
| > If your cluster does not contain **TiFlash** nodes, this SQL statement will report an error: `1105 - the tiflash replica count: 1 should be less than the total tiflash server count: 0`. You can use [Build a TiDB Cloud Starter Cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-cloud-starter-cluster) to create a TiDB Cloud Starter cluster that includes **TiFlash**. |
TOC-tidb-cloud.md
Outdated
| @@ -60,7 +60,7 @@ | |||
| - [C#](/develop/dev-guide-sample-application-cs.md) | |||
| - [WordPress](/tidb-cloud/dev-guide-wordpress.md) | |||
| - Serverless Driver (Beta) | |||
| - [TiDB Cloud Serverless Driver](/tidb-cloud/serverless-driver.md) | |||
| - [TiDB Cloud Starter Driver](/tidb-cloud/serverless-driver.md) | |||
There was a problem hiding this comment.
While the link text has been updated to 'TiDB Cloud Starter Driver', the URL /tidb-cloud/serverless-driver.md still uses 'serverless'. For consistency, the underlying file should also be renamed and the link updated. This maintains terminology consistency as recommended by the style guide.1 I've noticed this pattern for multiple links across the PR. It would be best to address them all for consistency, possibly in a follow-up PR if file renaming is out of scope for this one.
Style Guide References
Footnotes
| @@ -244,7 +244,7 @@ test> SELECT * FROM sf_account; | |||
|
|
|||
| - If anything goes wrong, you can navigate to the [CloudWatch](https://console.aws.amazon.com/cloudwatch/home) page on the AWS Management Console to get logs. | |||
| - The steps in this document are based on [Building custom connectors using the Amazon AppFlow Custom Connector SDK](https://aws.amazon.com/blogs/compute/building-custom-connectors-using-the-amazon-appflow-custom-connector-sdk/). | |||
| - [TiDB Cloud Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) is **NOT** a production environment. | |||
| - [TiDB Cloud Starter](https://docs.tidb.io/tidbcloud/select-cluster-tier#tidb-cloud-starter) is **NOT** a production environment. | |||
There was a problem hiding this comment.
The link anchor #tidb-cloud-serverless seems outdated. The target page select-cluster-tier.md now refers to 'TiDB Cloud Starter'. Please update the anchor to point to the correct section, which is likely #tidb-cloud-starter. This will ensure the link works as expected and maintains terminology consistency.1 This issue is present in multiple files throughout the pull request.
Style Guide References
| - [TiDB Cloud Starter](https://docs.tidb.io/tidbcloud/select-cluster-tier#tidb-cloud-starter) is **NOT** a production environment. | |
| - [TiDB Cloud Starter](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-starter) is **NOT** a production environment. |
Footnotes
| @@ -355,7 +355,7 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). | |||
| - To avoid SQL injection, it is recommended to use [prepared statements](https://github.com/sidorares/node-mysql2#using-prepared-statements). | |||
| - In scenarios where there are not many complex SQL statements involved, using ORM frameworks like [Sequelize](https://sequelize.org/), [TypeORM](https://typeorm.io/), or [Prisma](https://www.prisma.io/) can greatly improve development efficiency. | |||
| - For building a RESTful API for your application, it is recommended to [use AWS Lambda with API Gateway](https://docs.aws.amazon.com/lambda/latest/dg/services-apigateway.html). | |||
| - For designing high-performance applications using TiDB Cloud Serverless and AWS Lambda, refer to [this blog](https://aws.amazon.com/blogs/apn/designing-high-performance-applications-using-serverless-tidb-cloud-and-aws-lambda/). | |||
| - For designing high-performance applications using TiDB Cloud Starter and AWS Lambda, refer to [this blog](https://aws.amazon.com/blogs/apn/designing-high-performance-applications-using-serverless-tidb-cloud-and-aws-lambda/). | |||
There was a problem hiding this comment.
The link text here has been updated to 'TiDB Cloud Starter', but it points to an external blog post. The link text should accurately reflect the title of the external content, which likely has not been changed. Please revert this change to maintain accuracy.
| - For designing high-performance applications using TiDB Cloud Starter and AWS Lambda, refer to [this blog](https://aws.amazon.com/blogs/apn/designing-high-performance-applications-using-serverless-tidb-cloud-and-aws-lambda/). | |
| - For designing high-performance applications using TiDB Cloud Serverless and AWS Lambda, refer to [this blog](https://aws.amazon.com/blogs/apn/designing-high-performance-applications-using-serverless-tidb-cloud-and-aws-lambda/). |
tidb-resource-control-ru-groups.md
Outdated
| @@ -102,7 +102,7 @@ Request Unit (RU) is a unified abstraction unit in TiDB for system resources, wh | |||
| > **Note:** | |||
| > | |||
| > - Each write operation is eventually replicated to all replicas (by default, TiKV has 3 replicas). Each replication operation is considered a different write operation. | |||
| > - The preceding table lists only the resources involved in RU calculation for TiDB Self-Managed clusters, excluding the network and storage consumption. For TiDB Cloud Serverless RUs, see [TiDB Cloud Serverless Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details/). | |||
| > - The preceding table lists only the resources involved in RU calculation for TiDB Self-Managed clusters, excluding the network and storage consumption. For TiDB Cloud Starter RUs, see [TiDB Cloud Starter Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details/). | |||
There was a problem hiding this comment.
The link text has been updated to 'TiDB Cloud Starter Pricing Details', but the URL still contains 'serverless'. Please verify if this URL is correct or if it needs to be updated to reflect the new branding.
qiancai
force-pushed
the
rename-serverless
branch
from
075fa3c to
692ecaa
Compare
qiancai
force-pushed
the
rename-serverless
branch
from
692ecaa to
ca0f4cf
Compare
ti-chi-bot
bot
added
size/XS
qiancai
force-pushed
the
rename-serverless
branch
from
b95881b to
d92159c
Compare
ti-chi-bot
bot
added
size/XXL
qiancai
force-pushed
the
rename-serverless
branch
from
d92159c to
c733f0d
Compare
qiancai
force-pushed
the
rename-serverless
branch
from
bf0f32b to
ca0f4cf
Compare
ti-chi-bot
bot
added
size/XS
ti-chi-bot
bot
added
size/XXL
qiancai
force-pushed
the
rename-serverless
branch
from
07562f0 to
2f27f18
Compare
|
/retest |
qiancai
changed the title
qiancai
changed the title
qiancai
removed
the
missing-translation-status
ti-chi-bot
bot
removed
the
do-not-merge/work-in-progress
|
/retest |
lilin90
added
rename-serverless
[LGTM Timeline notifier]Timeline:
|
|
/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 |
What is changed, added or deleted? (Required)
This PR uses the {{{ .starter }}} variable to replace TiDB Cloud Serverless to simplify maintenance.
This PR is only for files outside the
tidb-cloudfolder.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?