Skip to content

i18n(ja): fix TiDB Cloud docs (serverless private link to terraform) found in the second full review - #24567

Open
yahonda wants to merge 10 commits into
pingcap:i18n-ja-release-8.5from
yahonda:i18n-ja-fix-tidb-cloud-top-c-2nd-review
Open

yahonda wants to merge 10 commits into
pingcap:i18n-ja-release-8.5from
yahonda:i18n-ja-fix-tidb-cloud-top-c-2nd-review

Conversation

@yahonda

@yahonda yahonda commented Oct 28, 2026 •

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

This PR fixes the Japanese TiDB Cloud docs from serverless-private-link-connection*.md to terraform-use-serverless-cluster-resource*.md (alphabetical). The fixes come from a second line-by-line review against the English source (release-8.5 at 6fa2484). The review covered 36 files, and 35 of them needed changes. Code blocks, commands, and URLs are unchanged, except where the English changed them (see "Sync lag").

  • Mistranslations:
    • size-your-cluster.md: 「本番環境への本番」 is now "production use", 「読む/書く」 in the tables is now 「読み取り/書き込み」, 「2万8000」 is now 28,000, and the headings 「サイズ TiDB」 etc. are now 「TiDB のサイズを決定する」.
    • sql-proxy-account.md: the "username and password" sentence had a doubled 「を使用して」, and the link to the removed anchor #remove-a-project-member now points to #remove-project-access-for-a-user.
    • Private endpoint pages: the status tables said "is being deleted/created" where the English says "is deleting/creating", and "has been created" was 「作成されます」.
    • Private link pages: attaching and detaching domains were 「接続」 and 「切断」.
    • terraform-use-restore-resource.md: "Then you can import the restored cluster" had the subject 「これら」. terraform-use-import-resource.md: "cannot update/cancel an import task" now uses the topic particle.
    • Kafka setup pages: the bastion-node sentences and the subnet lists had a wrong structure, and "can overlap" was 「重複する可能性がある」.
  • Sync lag: the English changes of April 2026 ("one console", c913fdf) had not reached these files. TiDB Cloud Starter and Essential "clusters" are now "instances", the organization switcher tips follow the new English, and https://tidbcloud.com/project/clusters is updated. Heading anchors that changed with the English headings have no incoming links.
  • Bold UI labels that had been translated are restored to English, for example the Azure portal (Virtual network name, Add a subnet, Next : Disks, ...), the Google Cloud console (Region, Zone, Machine Type, Subnetwork, Targets, ...), and Reminders before proceeding, Public IPv4 address, Alias of Private Link Service, and Domain Name of Endpoint Service.
  • Kafka listener names (CONTROLLER, INTERNAL, EXTERNAL) and the role names in sql-proxy-account.md are restored to the English literals.
  • Leftover English is translated: "multi-VPC connectivity", "broker type", "bootstrap broker string", "consumer group", "principal", "advertised listener", "DB user", "table", and "SQL type".
  • One rendering per term:
    • Private Service Connect, Azure Private Link, Amazon MSK Provisioned, and Kafka-proxy are kept as product names.
    • target group → ターゲットグループ, quota → クォータ, Region → リージョン
    • cluster: 「クラスタ」 → 「クラスター」 in files that used both forms
    • 「ステップ N. 」 step headings with a half-width period, and headings and link texts in the 「〜する」 form. Anchors are unchanged unless the English heading changed.
  • Notation: > and > in menu paths are now >, bold markers that did not render are fixed, and spaces inside katakana compounds are removed.

Update (2026-10-30)

  • "The possible statuses of a private endpoint (service) are explained as follows" is now 「プライベートエンドポイント(サービス)が取り得るステータスは次のとおりです。」 in all five private endpoint pages, including premium/connect-to-premium-via-aws-private-endpoint.md and premium/connect-to-premium-via-alibaba-cloud-private-endpoint.md (was 可能なステータス, which is hard to read).

  • Redundant can-form: 「〜することができます」 → 「〜できます」 (for example 設定することができます → 設定できます, 有効にすることができます → 有効にできます). Other conjugations are changed the same way (することができ、 → でき、, することができません → できません, することができました → できました, and so on). 「〜することもできます」 and 「〜することはできません」 are kept. Text inside code is not changed.

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.

  • i18n-ja-release-8.5 (TiDB Japanese documentation for TiDB 8.5 versions)

What is the related PR or file 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
    • Revised Japanese guides across private endpoint connections, Kafka integrations, Terraform, and SQL topics for clearer wording and consistent terminology.
    • Clarified that Starter and Essential resources are instances, and updated connection instructions to identify the organization and instance to select.
    • Clarified Amazon MSK secret naming and custom KMS key requirements, the exclusion of t3.small, network connectivity, and inbound port guidance. Specified that AWS PrivateLink supports Confluent Cloud Dedicated clusters.
    • Refined cluster-sizing information, corrected a TiKV read-QPS figure, and updated Terraform version formatting and API-key navigation.

…found in the second full review

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ti-chi-bot

ti-chi-bot Bot commented Oct 28, 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 28, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 28, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign oreoxmt for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found 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

@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 3f98d88 and db2822c.

Files selected for processing: 2
  • tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-private-endpoint.md
  • tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md

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

Walkthrough

The pull request revises Japanese TiDB Cloud documentation across private connectivity, Kafka, product, SQL, and Terraform topics. It updates resource terminology and selected setup instructions; most documented procedures and configuration values remain unchanged.

Changes: Documentation updates

Layer / File(s) Summary
Private Link and Kafka connection guides
tidb-cloud/serverless-private-link-connection*.md
The guides refer to TiDB Cloud Essential instances and Amazon MSK Provisioned. They clarify selected region, availability-zone, secret, bastion connectivity, and load-balancer instructions.
Private endpoint and VPC peering guides
tidb-cloud/set-up-private-endpoint-connections*.md, tidb-cloud/set-up-sink-private-endpoint.md, tidb-cloud/set-up-vpc-peering-connections.md
The guides revise Japanese wording, console labels, and resource references. Their documented connection limits and setup steps are generally retained.
Kafka Private Link service setup
tidb-cloud/setup-*-kafka-*.md
The guides revise console field names and listener terminology. They state that t3.small brokers are unsupported and clarify selected Kafka setup requirements.
Product and SQL documentation
tidb-cloud/size-your-cluster.md, tidb-cloud/sql-*.md, tidb-cloud/statement-insight.md
The guides revise instance terminology, role labels, and metric wording. The TiKV read-QPS value is reformatted as 28,000.
Terraform documentation
tidb-cloud/terraform-*.md
The guides revise Starter and Essential resource references, terminology, version formatting, and selected import instructions. Terraform workflows and examples are generally unchanged.

Priority: Normal

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Other

Suggested reviewers: qiancai

Merge Risk: Low · up to db282

Users following the documented Terraform prerequisite may use an unsupported version and encounter import failures; the remaining review comments do not identify defects.

Pre-merge checks: Passed 4
Check name Status Explanation
Title check Passed The title identifies Japanese TiDB Cloud documentation fixes from a second review. It is related to the main changes, although the scope is broader than serverless private-link and Terraform documenta…
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.
Description check Passed The pull request description is detailed and covers the changes, affected Japanese 8.5 documentation branch, source documentation link, AI involvement, and scope checkboxes. The optional first-time co…
Full details: Title check

Explanation

The title identifies Japanese TiDB Cloud documentation fixes from a second review. It is related to the main changes, although the scope is broader than serverless private-link and Terraform documentation.

Full details: Description check

Explanation

The pull request description is detailed and covers the changes, affected Japanese 8.5 documentation branch, source documentation link, AI involvement, and scope checkboxes. The optional first-time contributor section is omitted, which is allowed. The version checkbox uses the repository-specific i18n-ja-release-8.5 branch rather than the generic template list, but the affected version is clearly identified.

Finishing Touches: 💡 1
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR
🧪 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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Oct 28, 2026
yahonda and others added 4 commits October 28, 2026 17:28
…private link guide

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…private link guides

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… the AWS RDS private link guide

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…dpoints

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@yahonda
yahonda marked this pull request as ready for review October 29, 2026 02:35
@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 29, 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.

🔇 Additional comments: 1
tidb-cloud/set-up-sink-private-endpoint.md-54-54: 1

54-54: Minor · Functional Correctness · Quick win

⚠️ Unverified finding
Verification ran but could not confirm this finding. It is shown for review, not as a verified issue.

Use the official product name Private Service Connect.

プライベートサービス接続サービス does not match the product name used by the linked Google Cloud guide. Keep the product name consistent so readers can find the correct console resource and setup step. (raw.githubusercontent.com)

Committable suggestion
ダウンストリームサービスでサービスアタッチメントが利用できない場合は、[ステップ2. Kafka-proxyをPrivate Service Connect サービスとして公開する](/tidb-cloud/setup-self-hosted-kafka-private-service-connect.md#step-2-expose-kafka-proxy-as-private-service-connect-service)に従ってサービスアタッチメント情報を取得します。

As per path instructions, this Markdown correction uses a committable suggestion block.

Source: Path instructions


Review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 1ab23c8 and f8df6e5.

Files selected for processing: 35
  • tidb-cloud/serverless-private-link-connection-to-amazon-msk.md
  • tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
  • tidb-cloud/serverless-private-link-connection-to-aws-rds.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/serverless-private-link-connection.md
  • tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md
  • tidb-cloud/set-up-private-endpoint-connections-on-azure.md
  • tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md
  • tidb-cloud/set-up-private-endpoint-connections-serverless.md
  • tidb-cloud/set-up-private-endpoint-connections.md
  • tidb-cloud/set-up-sink-private-endpoint.md
  • tidb-cloud/set-up-vpc-peering-connections.md
  • tidb-cloud/setup-aws-msk-provisioned-private-link-service.md
  • tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md
  • tidb-cloud/setup-azure-self-hosted-kafka-private-link-service.md
  • tidb-cloud/setup-self-hosted-kafka-private-service-connect.md
  • tidb-cloud/size-your-cluster.md
  • tidb-cloud/sql-concepts.md
  • tidb-cloud/sql-proxy-account.md
  • tidb-cloud/statement-insight.md
  • tidb-cloud/terraform-get-tidbcloud-provider.md
  • tidb-cloud/terraform-migrate-cluster-resource.md
  • tidb-cloud/terraform-tidbcloud-provider-overview.md
  • tidb-cloud/terraform-use-backup-resource.md
  • tidb-cloud/terraform-use-cluster-resource.md
  • tidb-cloud/terraform-use-dedicated-cluster-resource.md
  • tidb-cloud/terraform-use-dedicated-network-container-resource.md
  • tidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.md
  • tidb-cloud/terraform-use-dedicated-vpc-peering-resource.md
  • tidb-cloud/terraform-use-import-resource.md
  • tidb-cloud/terraform-use-restore-resource.md
  • tidb-cloud/terraform-use-serverless-branch-resource.md
  • tidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.md
  • tidb-cloud/terraform-use-serverless-cluster-resource.md

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

yahonda and others added 2 commits October 29, 2026 11:49
…eading

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…hrases

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@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: 1

Caution

Some comments are outside the diff and can’t be posted inline due to GitHub limitations.

⚠️ Outside diff range comments (1)

Minor · Document the Terraform version required by the… · terraform-use-dedicated-private-endpoint-connection-resource.md:151

tidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.md:151
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Document the Terraform version required by the import workflow.

Terraform import blocks and terraform plan -generate-config-out=generated.tf require Terraform 1.5.0 or later. Both dedicated-resource guides link to prerequisites that allow Terraform 1.0–1.4, so users can satisfy the documented prerequisite and still fail at the import steps. Add an import-specific Terraform 1.5.0 prerequisite to both guides. Do not raise the shared provider requirement globally without confirming that all provider workflows require Terraform 1.5.0.


Review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between f8df6e5 and 3f98d88.

Files selected for processing: 5
  • tidb-cloud/set-up-sink-private-endpoint.md
  • tidb-cloud/terraform-tidbcloud-provider-overview.md
  • tidb-cloud/terraform-use-cluster-resource.md
  • tidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.md
  • tidb-cloud/terraform-use-dedicated-vpc-peering-resource.md

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

yahonda and others added 3 commits October 29, 2026 14:39
…dpoint pages

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant