Skip to content

tidb-cloud: fix code fences, duplicated text, and wrong values in TiDB Cloud docs - #24487

Merged
ti-chi-bot[bot] merged 1 commit into
pingcap:masterfrom
yahonda:tidb-cloud-fix-fences-duplicates-and-examples
Oct 27, 2026
Merged

ti-chi-bot[bot] merged 1 commit into
pingcap:masterfrom
yahonda:tidb-cloud-fix-fences-duplicates-and-examples

Conversation

@yahonda

@yahonda yahonda commented Oct 19, 2026 •

Copy link
Copy Markdown
Member

What is changed, added, or deleted? (Required)

Fix code fences, duplicated text, and wrong values in the TiDB Cloud docs. These errors were found while reviewing the English docs for issues that affect the Japanese translation. Each fix is shown below; the same wrong text was also searched for in the rest of the docs.

File Before After
tidb-cloud/dedicated-external-storage.md A JSON code block opens with 4 backticks and closes with 3 Open it with 3 backticks
releases/release-7.6.0.md A SQL code block opens with 3 backticks and closes with 4 Close it with 3 backticks
tidb-cloud/set-up-private-endpoint-connections.md "Go to VPC > Endpoints. To do so, go to VPC > Endpoints, …" Remove the duplicated first sentence
tidb-cloud/sql-concepts.md The "Since the value of AUTO_RANDOM is random and unique, …" sentence appears twice in a row Keep it once
tidb-cloud/terraform-get-tidbcloud-provider.md The example for "By setting sync to true" does not set sync Add sync = true
tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md, …-in-aws.md, setup-aws-self-hosted-kafka-private-link-service.md The comment says "b2.…:9095" while the configuration line below it is for b3 "b3.…:9095"
tidb-cloud/use-chat2query-api.md HTTP method DEL DELETE
tidb-cloud/migrate-from-op-tidb.md After SET GLOBAL tidb_gc_enable = TRUE, "1 indicates that GC is disabled" "enabled"
tidb-cloud/tidb-cloud-password-authentication.md Note: "Google SSO or GitHub SSO … managed by Google or GitHub" Include Microsoft, as in the rest of the page

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

  • Related code change PR links (if applicable):
  • This PR is translated from:
  • Other reference link(s):

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Corrected SQL and JSON code-fence formatting in examples.
    • Fixed migration guidance describing the enabled GC state.
    • Corrected Kafka broker identifiers in private-link configuration examples.
    • Simplified private endpoint DNS troubleshooting steps.
    • Clarified AUTO_RANDOM behavior and added a conversion example.
    • Documented synchronous Terraform resource operations for cluster resources.
    • Expanded password-management guidance for SSO providers.
    • Corrected the Chat2Query knowledge-base deletion method to DELETE.

…B Cloud docs

- 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 <noreply@anthropic.com>
@ti-chi-bot

ti-chi-bot Bot commented Oct 19, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 19, 2026
@coderabbitai

coderabbitai Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

📝 Walkthrough

This pull request updates release and TiDB Cloud documentation. It corrects code fences, Kafka broker examples, configuration guidance, and descriptions of SQL, authentication, and API behavior.

Changes: Documentation corrections

Layer / File(s) Summary
Code fence corrections
releases/release-7.6.0.md, tidb-cloud/dedicated-external-storage.md
Corrected code fence lengths in a SQL example and an AWS S3 policy template.
Kafka broker examples
tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md, tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md, tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md
Updated broker 3 EXTERNAL advertised-listener examples to use broker identifier b3.
TiDB Cloud configuration guidance
tidb-cloud/migrate-from-op-tidb.md, tidb-cloud/set-up-private-endpoint-connections.md, tidb-cloud/terraform-get-tidbcloud-provider.md
Corrected the documented GC state, removed a duplicated AWS console navigation step, and added sync = true to the Terraform provider example.
Product reference updates
tidb-cloud/sql-concepts.md, tidb-cloud/tidb-cloud-password-authentication.md, tidb-cloud/use-chat2query-api.md
Revised the AUTO_RANDOM explanation, included Microsoft SSO in password reset guidance, and corrected the Chat2Query deletion method label to DELETE.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Bug fix

Merge Risk: 🔵 Low · up to 6671e

Two documentation examples could mislead users during schema migration or Kafka setup; correcting them is low-risk and localized.

Architecture Summary

Architecture risk: 🔵 Low · up to 6671e

The change affects 2 systems.

Changed systems: tidb-cloud, releases

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — tidb-cloud (service) was modified; 10 changed files map to changed impact.
  • observed — releases (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in releases/release-7.6.0.md: The SQL example’s closing code fence was corrected from four backticks to three.
  • observed — Modified behavior in tidb-cloud/dedicated-external-storage.md: The AWS S3 policy template’s opening code fence now uses standard three-backtick Markdown syntax instead of four backticks.
  • observed — Modified behavior in tidb-cloud/migrate-from-op-tidb.md: Updated the example output description to state that 1 indicates GC is enabled rather than disabled.
  • observed — Modified behavior in tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md: Corrected the broker 3 configuration comment from the broker 2 hostname example to the broker 3 hostname example.
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly summarizes the documentation fixes, including code fences, duplicated text, and incorrect values. It is concise and directly related to the changes.
Description check Passed The description includes the required change summary, affected versions, reference-link section, AI involvement, and change-category checklist. It provides file-specific details for all documented fix…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description includes the required change summary, affected versions, reference-link section, AI involvement, and change-category checklist. It provides file-specific details for all documented fixes.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (11 skipped: 11 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 19, 2026
@yahonda
yahonda marked this pull request as ready for review October 20, 2026 00:11
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 20, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2


ℹ️ Review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 86b19858-2847-4284-a072-a3541d6d57b2
📥 Commits

Reviewing files that changed from the base of the PR and between 3ba897a and 6671e25.

📒 Files selected for processing: 11
  • releases/release-7.6.0.md
  • tidb-cloud/dedicated-external-storage.md
  • tidb-cloud/migrate-from-op-tidb.md
  • tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md
  • tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md
  • tidb-cloud/set-up-private-endpoint-connections.md
  • tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md
  • tidb-cloud/sql-concepts.md
  • tidb-cloud/terraform-get-tidbcloud-provider.md
  • tidb-cloud/tidb-cloud-password-authentication.md
  • tidb-cloud/use-chat2query-api.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Comment thread tidb-cloud/sql-concepts.md
@qiancai qiancai added the translation/no-need No need to translate this PR. label Oct 27, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Oct 27, 2026
@qiancai qiancai added translation/doing This PR's assignee is translating this PR. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. labels Oct 27, 2026
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Oct 27, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 27, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-10-27 13:45:01.264543866 +0000 UTC m=+469038.756256125: ☑️ agreed by qiancai.

@qiancai

qiancai commented Oct 27, 2026

Copy link
Copy Markdown
Collaborator

/approve

@qiancai qiancai added the lgtm label Oct 27, 2026
@qiancai qiancai self-assigned this Oct 27, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 27, 2026

Copy link
Copy Markdown

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@qiancai qiancai removed the translation/no-need No need to translate this PR. label Oct 27, 2026
@ti-chi-bot ti-chi-bot Bot added the approved label Oct 27, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit eb2cdf3 into pingcap:master Oct 27, 2026
10 of 11 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #24561.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants