Repository navigation
i18n(ja): fix TiDB Cloud docs (serverless private link to terraform) found in the second full review - #24567
i18n(ja): fix TiDB Cloud docs (serverless private link to terraform) found in the second full review#24567yahonda wants to merge 10 commits into
Conversation
…found in the second full review Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Skipping CI for Draft Pull Request. |
|
[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 |
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review.
|
| 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:
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: 
4
-
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.
Comment @coderabbitai help to get the list of available commands.
…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>
There was a problem hiding this comment.
🔇 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-
- Source mode: Auto
- Repository: pingcap/docs
- Branch: i18n-ja-release-8.5
- File: .coderabbit.yaml
- Commit: 1ab23c8
- Layers: Repository YAML
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
4b7f44ff-e343-47e8-9e9f-e114dfe08fd9
Files selected for processing: 35-
tidb-cloud/serverless-private-link-connection-to-amazon-msk.mdtidb-cloud/serverless-private-link-connection-to-aws-confluent.mdtidb-cloud/serverless-private-link-connection-to-aws-rds.mdtidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.mdtidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.mdtidb-cloud/serverless-private-link-connection.mdtidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.mdtidb-cloud/set-up-private-endpoint-connections-on-azure.mdtidb-cloud/set-up-private-endpoint-connections-on-google-cloud.mdtidb-cloud/set-up-private-endpoint-connections-serverless.mdtidb-cloud/set-up-private-endpoint-connections.mdtidb-cloud/set-up-sink-private-endpoint.mdtidb-cloud/set-up-vpc-peering-connections.mdtidb-cloud/setup-aws-msk-provisioned-private-link-service.mdtidb-cloud/setup-aws-self-hosted-kafka-private-link-service.mdtidb-cloud/setup-azure-self-hosted-kafka-private-link-service.mdtidb-cloud/setup-self-hosted-kafka-private-service-connect.mdtidb-cloud/size-your-cluster.mdtidb-cloud/sql-concepts.mdtidb-cloud/sql-proxy-account.mdtidb-cloud/statement-insight.mdtidb-cloud/terraform-get-tidbcloud-provider.mdtidb-cloud/terraform-migrate-cluster-resource.mdtidb-cloud/terraform-tidbcloud-provider-overview.mdtidb-cloud/terraform-use-backup-resource.mdtidb-cloud/terraform-use-cluster-resource.mdtidb-cloud/terraform-use-dedicated-cluster-resource.mdtidb-cloud/terraform-use-dedicated-network-container-resource.mdtidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.mdtidb-cloud/terraform-use-dedicated-vpc-peering-resource.mdtidb-cloud/terraform-use-import-resource.mdtidb-cloud/terraform-use-restore-resource.mdtidb-cloud/terraform-use-serverless-branch-resource.mdtidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.mdtidb-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.
-
…eading Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…hrases Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to GitHub limitations.

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 winDocument the Terraform version required by the import workflow.
Terraform
importblocks andterraform plan -generate-config-out=generated.tfrequire 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-
- Source mode: Auto
- Repository: pingcap/docs
- Branch: i18n-ja-release-8.5
- File: .coderabbit.yaml
- Commit: 1ab23c8
- Layers: Repository YAML
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
dbe8ef21-3c4f-4438-946d-d8839916b565
Files selected for processing: 5-
tidb-cloud/set-up-sink-private-endpoint.mdtidb-cloud/terraform-tidbcloud-provider-overview.mdtidb-cloud/terraform-use-cluster-resource.mdtidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.mdtidb-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.
-
…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>
What is changed, added or deleted? (Required)
This PR fixes the Japanese TiDB Cloud docs from
serverless-private-link-connection*.mdtoterraform-use-serverless-cluster-resource*.md(alphabetical). The fixes come from a second line-by-line review against the English source (release-8.5at 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").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-membernow points to#remove-project-access-for-a-user.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.https://tidbcloud.com/project/clustersis updated. Heading anchors that changed with the English headings have no incoming links.CONTROLLER,INTERNAL,EXTERNAL) and the role names insql-proxy-account.mdare restored to the English literals.>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.mdandpremium/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.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
🤖 Generated with Claude Code
Summary by CodeRabbit
t3.small, network connectivity, and inbound port guidance. Specified that AWS PrivateLink supports Confluent Cloud Dedicated clusters.