From 6671e256ebbda03c1e9b4ce337c12261595c157d Mon Sep 17 00:00:00 2001 From: Yasuo Honda Date: Mon, 19 Oct 2026 16:41:56 +0900 Subject: [PATCH] tidb-cloud: fix code fences, duplicated text, and wrong values in TiDB Cloud docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Fix mismatched code fences in dedicated-external-storage.md (4 vs 3 backticks) and in the v7.6.0 release notes. - Remove a duplicated "Go to VPC > Endpoints" sentence and a duplicated AUTO_RANDOM sentence. - Add `sync = true` to the Terraform provider example that describes setting `sync` to `true`. - Fix the broker ID in the Kafka advertised listener comment (b2 → b3) in three Kafka private link docs, to match the configuration line. - Use the HTTP method name DELETE instead of DEL in the Chat2Query API table. - Fix "`1` indicates that GC is disabled" right after enabling GC. - Include Microsoft SSO in the password authentication note, as in the rest of the page. Co-Authored-By: Claude Opus 5.5 --- releases/release-7.6.0.md | 2 +- tidb-cloud/dedicated-external-storage.md | 2 +- tidb-cloud/migrate-from-op-tidb.md | 2 +- ...-private-link-connection-to-self-hosted-kafka-in-alicloud.md | 2 +- ...rless-private-link-connection-to-self-hosted-kafka-in-aws.md | 2 +- tidb-cloud/set-up-private-endpoint-connections.md | 2 +- tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md | 2 +- tidb-cloud/sql-concepts.md | 2 +- tidb-cloud/terraform-get-tidbcloud-provider.md | 1 + tidb-cloud/tidb-cloud-password-authentication.md | 2 +- tidb-cloud/use-chat2query-api.md | 2 +- 11 files changed, 11 insertions(+), 10 deletions(-) diff --git a/releases/release-7.6.0.md b/releases/release-7.6.0.md index d7f01a9bd2210..3135b6513c568 100644 --- a/releases/release-7.6.0.md +++ b/releases/release-7.6.0.md @@ -176,7 +176,7 @@ Quick access: [Quick start](https://docs-archive.pingcap.com/tidb/v7.6/quick-sta ```sql FLASHBACK CLUSTER TO TSO 445494839813079041; - ```` + ``` For more information, see [documentation](/sql-statements/sql-statement-flashback-cluster.md). diff --git a/tidb-cloud/dedicated-external-storage.md b/tidb-cloud/dedicated-external-storage.md index f8d744461d004..f60c4aa34aba8 100644 --- a/tidb-cloud/dedicated-external-storage.md +++ b/tidb-cloud/dedicated-external-storage.md @@ -51,7 +51,7 @@ Configure the bucket access for TiDB Cloud and get the Role ARN as follows: 4. On the **Create policy** page, click the **JSON** tab. 5. Copy the following access policy template and paste it into the policy text field. - ````json + ```json { "Version": "2012-10-17", "Statement": [ diff --git a/tidb-cloud/migrate-from-op-tidb.md b/tidb-cloud/migrate-from-op-tidb.md index 0d59999f76ab7..c70ec24d6cf59 100644 --- a/tidb-cloud/migrate-from-op-tidb.md +++ b/tidb-cloud/migrate-from-op-tidb.md @@ -325,7 +325,7 @@ To replicate incremental data, do the following: SET GLOBAL tidb_gc_enable = TRUE; ``` - The following is an example output, in which `1` indicates that GC is disabled. + The following is an example output, in which `1` indicates that GC is enabled. ```sql SELECT @@global.tidb_gc_enable; diff --git a/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md b/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md index 47497ce2ede78..c1fac0eccbd9d 100644 --- a/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md +++ b/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md @@ -501,7 +501,7 @@ The following configuration applies to a Kafka KRaft cluster. The ZK mode config # Add EXTERNAL advertised listeners based on the "Kafka Advertised Listener Pattern" in "Prerequisites" section # 1. The pattern is ".unique_name.alicloud.plc.tidbcloud.com:" - # 2. So the EXTERNAL can be "b2.unique_name.alicloud.plc.tidbcloud.com:9095". Replace with "b" prefix plus "node.id" properties, and replace with a unique port(9095) in EXTERNAL advertised listener ports range. + # 2. So the EXTERNAL can be "b3.unique_name.alicloud.plc.tidbcloud.com:9095". Replace with "b" prefix plus "node.id" properties, and replace with a unique port(9095) in EXTERNAL advertised listener ports range. advertised.listeners=...,EXTERNAL://b3.unique_name.alicloud.plc.tidbcloud.com:9095 # Configure EXTERNAL map diff --git a/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md b/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md index 41913cbf1012a..64c131116dc93 100644 --- a/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md +++ b/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md @@ -569,7 +569,7 @@ The following configuration applies to a Kafka KRaft cluster. The ZK mode config # Add EXTERNAL advertised listeners based on the "Kafka Advertised Listener Pattern" in "Prerequisites" section # 1. The pattern for AZ(ID: usw2-az3) is ".usw2-az3.unique_name.aws.plc.tidbcloud.com:" - # 2. So the EXTERNAL can be "b2.usw2-az3.unique_name.aws.plc.tidbcloud.com:9095". Replace with "b" prefix plus "node.id" properties, and replace with a unique port(9095) in EXTERNAL advertised listener ports range. + # 2. So the EXTERNAL can be "b3.usw2-az3.unique_name.aws.plc.tidbcloud.com:9095". Replace with "b" prefix plus "node.id" properties, and replace with a unique port(9095) in EXTERNAL advertised listener ports range. advertised.listeners=...,EXTERNAL://b3.usw2-az3.unique_name.aws.plc.tidbcloud.com:9095 # Configure EXTERNAL map diff --git a/tidb-cloud/set-up-private-endpoint-connections.md b/tidb-cloud/set-up-private-endpoint-connections.md index 6cc3d9befef8f..cbc23dc77cd9b 100644 --- a/tidb-cloud/set-up-private-endpoint-connections.md +++ b/tidb-cloud/set-up-private-endpoint-connections.md @@ -207,6 +207,6 @@ The possible statuses of a private endpoint service are explained as follows: ### I cannot connect to a TiDB cluster via a private endpoint after enabling private DNS. Why? -You might need to properly set the security group for your VPC endpoint in the AWS Management Console. Go to **VPC** > **Endpoints**. To do so, go to **VPC** > **Endpoints**, right-click your VPC endpoint, and select **Manage security groups**. Ensure that the selected security group allows inbound access from your EC2 instances on port `4000` or a customer-defined port. +You might need to properly set the security group for your VPC endpoint in the AWS Management Console. To do so, go to **VPC** > **Endpoints**, right-click your VPC endpoint, and select **Manage security groups**. Ensure that the selected security group allows inbound access from your EC2 instances on port `4000` or a customer-defined port. ![Manage security groups](/media/tidb-cloud/private-endpoint/manage-security-groups.png) diff --git a/tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md b/tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md index 56ff6ba19be7e..fe09b757a5a11 100644 --- a/tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md +++ b/tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md @@ -615,7 +615,7 @@ The following configuration applies to a Kafka KRaft cluster. The ZK mode config # Add EXTERNAL advertised listeners based on the "Kafka Advertised Listener Pattern" in "Prerequisites" section # 1. The pattern for AZ(ID: usw2-az3) is ".usw2-az3.abc.us-west-2.aws.3199015.tidbcloud.com:" - # 2. So the EXTERNAL can be "b2.usw2-az3.abc.us-west-2.aws.3199015.tidbcloud.com:9095". Replace with "b" prefix plus "node.id" properties, and replace with a unique port(9095) in EXTERNAL advertised listener ports range. + # 2. So the EXTERNAL can be "b3.usw2-az3.abc.us-west-2.aws.3199015.tidbcloud.com:9095". Replace with "b" prefix plus "node.id" properties, and replace with a unique port(9095) in EXTERNAL advertised listener ports range. advertised.listeners=...,EXTERNAL://b3.usw2-az3.abc.us-west-2.aws.3199015.tidbcloud.com:9095 # Configure EXTERNAL map diff --git a/tidb-cloud/sql-concepts.md b/tidb-cloud/sql-concepts.md index e70a2d01de4ad..701ef45be9bae 100644 --- a/tidb-cloud/sql-concepts.md +++ b/tidb-cloud/sql-concepts.md @@ -55,7 +55,7 @@ For more information, see [AUTO_INCREMENT](/auto-increment.md). ### AUTO_RANDOM -`AUTO_RANDOM` is a column attribute that is used to automatically assign values to a `BIGINT` column. Values assigned automatically are random and unique. Since the value of `AUTO_RANDOM` is random and unique, `AUTO_RANDOM` is often used in place of [`AUTO_INCREMENT`](/auto-increment.md) to avoid write hotspots in a single storage node caused by TiDB assigning consecutive IDs. +`AUTO_RANDOM` is a column attribute that is used to automatically assign values to a `BIGINT` column. Values assigned automatically are random and unique. Since the value of `AUTO_RANDOM` is random and unique, `AUTO_RANDOM` is often used in place of [`AUTO_INCREMENT`](/auto-increment.md) to avoid write hotspots in a single storage node caused by TiDB assigning consecutive IDs. If the current `AUTO_INCREMENT` column is a primary key and the type is `BIGINT`, you can execute the `ALTER TABLE t MODIFY COLUMN id BIGINT AUTO_RANDOM(5);` statement to switch from `AUTO_INCREMENT` to `AUTO_RANDOM`. diff --git a/tidb-cloud/terraform-get-tidbcloud-provider.md b/tidb-cloud/terraform-get-tidbcloud-provider.md index acfb7e1b5f29e..dd1bbf4dc6fa8 100644 --- a/tidb-cloud/terraform-get-tidbcloud-provider.md +++ b/tidb-cloud/terraform-get-tidbcloud-provider.md @@ -119,6 +119,7 @@ By setting `sync` to `true`, you can create, update, or delete resources synchro provider "tidbcloud" { public_key = "your_public_key" private_key = "your_private_key" + sync = true } ``` diff --git a/tidb-cloud/tidb-cloud-password-authentication.md b/tidb-cloud/tidb-cloud-password-authentication.md index 94db91a66760d..8d4d21c6790f1 100644 --- a/tidb-cloud/tidb-cloud-password-authentication.md +++ b/tidb-cloud/tidb-cloud-password-authentication.md @@ -58,7 +58,7 @@ The default password policy is as follows: > **Note:** > -> This section is only applicable to TiDB Cloud registration with email and password. If you sign up for TiDB Cloud with Google SSO or GitHub SSO, your password is managed by Google or GitHub and you cannot change it using the TiDB Cloud console. +> This section is only applicable to TiDB Cloud registration with email and password. If you sign up for TiDB Cloud with Google, GitHub, or Microsoft SSO, your password is managed by Google, GitHub, or Microsoft and you cannot change it using the TiDB Cloud console. If you forget your password, you can reset it by email as follows: diff --git a/tidb-cloud/use-chat2query-api.md b/tidb-cloud/use-chat2query-api.md index 15b946b9ae90e..36dd62725e630 100644 --- a/tidb-cloud/use-chat2query-api.md +++ b/tidb-cloud/use-chat2query-api.md @@ -114,7 +114,7 @@ TiDB Cloud Data Service provides the following Chat2Query v3 endpoints and v2 en | POST | `/v3/knowledgeBases/{knowledge_base_id}/data` | This endpoint adds data to a specific knowledge base. | | GET | `/v3/knowledgeBases/{knowledge_base_id}/data` | This endpoint retrieves data from a specific knowledge base. | | PUT | `/v3/knowledgeBases/{knowledge_base_id}/data/{knowledge_data_id}` | This endpoint updates specific data in a knowledge base. | -| DEL | `/v3/knowledgeBases/{knowledge_base_id}/data/{knowledge_data_id}` | This endpoint deletes specific data from a knowledge base. | +| DELETE | `/v3/knowledgeBases/{knowledge_base_id}/data/{knowledge_data_id}` | This endpoint deletes specific data from a knowledge base. | | POST | `/v3/sessions` | This endpoint creates a new session. For more information about the usage of session-related endpoints, see [Start multi-round Chat2Query](/tidb-cloud/use-chat2query-sessions.md). | | GET | `/v3/sessions` | This endpoint retrieves a list of all sessions. | | GET | `/v3/sessions/{session_id}` | This endpoint retrieves the details of a specific session. |