Skip to content

i18n(ja): fix residual English and terms in the TiDB Cloud BYOC docs - #24483

Open
yahonda wants to merge 7 commits into
pingcap:i18n-ja-release-8.5from
yahonda:i18n-ja-fix-byoc-docs
Open

yahonda wants to merge 7 commits into
pingcap:i18n-ja-release-8.5from
yahonda:i18n-ja-fix-byoc-docs

Conversation

@yahonda

@yahonda yahonda commented Oct 19, 2026 •

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

The 2026-10-16 syncs #24467 and #24472 were merged without a review. This is one of four PRs that fix the Japanese they added or changed, reviewed line by line against the English (1b1d01f8...e65d1259). The four PRs touch different files and can be merged in any order. This PR fixes the new TiDB Cloud BYOC docs (tidb-cloud/byoc/ and TOC-tidb-cloud-byoc.md).

  • Translate headings, table headers, labels, and link texts left in English, and lowercase nouns: hosted zone → ホストゾーン, bastion host → 踏み台ホスト (as the TOC already says), observability → 可観測性, quota, certificate authority, resource pool CIDR, and others. Use 「ステップ N.」 for steps.
  • Fix TOC entries that do not follow existing terms or the target page titles: 列プルーニング, 実行プランキャッシュ, 集計, 購読, 階層型ストレージ, and translated page titles. Entries that differ from the sibling TOCs only in spacing or wording are left as is.
  • Use キャパシティ for compute capacity in byoc-prepare-environment-aws.md and manage-resource-pools-byoc.md (3 lines; the EBS volume capacity stays 容量). The rest of this term change is in i18n(ja): use the katakana term for compute capacity in TiDB Cloud and RU docs #24497; these lines are fixed here because this PR also edits them.

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
    • Updated Japanese TiDB Cloud BYOC guides and table-of-contents labels with consistent terminology, headings, and link text.
    • Clarified multi-region deployment guidance, including region ordering, preflight checks, and CIDR reuse and overlap requirements.
    • Added clarification that persistent bastion host connections are not required and access channels can be terminated at any time.
    • Deployment steps, links, values, and operational requirements remain unchanged.

Fix the Japanese of the TiDB Cloud BYOC docs that the 2026-10-16 sync
(pingcap#24472) added without review:

- Translate headings, table headers, labels, link texts, and lowercase
  nouns left in English (hosted zone → ホストゾーン, bastion host →
  踏み台ホスト, observability → 可観測性, quota, certificate authority,
  resource pool CIDR, and others), and use 「ステップ N.」 for steps.
- Fix TOC entries that do not follow existing terms or target titles
  (列プルーニング, 実行プランキャッシュ, 集計, 購読, 階層型ストレージ,
  and translated page titles).

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 Japanese labels and terminology across the TiDB Cloud table of contents and BYOC guides. It also clarifies multi-region CIDR overlap conditions and adds a note about ending the service access channel.

Changes: Japanese documentation updates

Layer / File(s) Summary
TiDB Cloud TOC labels
TOC-tidb-cloud-byoc.md
Japanese labels and one section heading were updated across optimization, imports, IAM, billing, SQL references, subscriptions, and other entries. Link targets remain unchanged.
BYOC deployment preparation
tidb-cloud/byoc/byoc-automated-deployment.md, tidb-cloud/byoc/byoc-onboarding-overview.md, tidb-cloud/byoc/byoc-prepare-environment-aws.md
Deployment, onboarding, and AWS preparation labels were localized. The documented requirements and steps remain unchanged.
BYOC access and service setup
tidb-cloud/byoc/byoc-configure-iam-permissions.md, tidb-cloud/byoc/byoc-configure-bastion-host.md, tidb-cloud/byoc/byoc-initialize-service.md, tidb-cloud/byoc/create-tidb-instance-byoc.md
Guide wording and link labels were localized. The service initialization guide adds a note that the access channel can be ended at any time.
Resource pool and multi-region guidance
tidb-cloud/byoc/create-resource-pool-byoc.md, tidb-cloud/byoc/manage-resource-pools-byoc.md, tidb-cloud/byoc/multi-region-deployment.md
Resource pool and multi-region terminology was localized. The multi-region checklist clarifies CIDR overlap conditions across regions and connected networks.
Validation and security guide labels
tidb-cloud/byoc/joint-validation.md, tidb-cloud/byoc/security-hardening.md
Checklist labels and security-hardening terminology were updated in Japanese. The checks and security procedures remain unchanged.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: 🟡 Moderate · up to cba85

The CIDR guidance remains unclear and the PR triggers documentation lint failures, so these issues should be resolved before merging.

Architecture Summary

Architecture risk: 🔵 Low · up to cba85

The change affects 2 systems.

Changed systems: tidb-cloud, TOC-tidb-cloud-byoc.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — tidb-cloud (service) was modified; 12 changed files map to changed impact.
  • observed — TOC-tidb-cloud-byoc.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in tidb-cloud/byoc/byoc-configure-iam-permissions.md: AWS CLI と TiDB Cloud アカウント情報に関する要件の項目名を日本語に変更しました。
  • observed — Modified behavior in tidb-cloud/byoc/byoc-configure-iam-permissions.md: パラメーター表の列見出しを日本語にし、Hosted Zone の説明を「ホストゾーン」に変更しました。
  • observed — Modified behavior in tidb-cloud/byoc/byoc-configure-iam-permissions.md: スクリプトのダウンロード元を示す文の「PingCAP GitHub repository」を日本語表記に変更しました。
  • observed — Modified behavior in tidb-cloud/byoc/byoc-configure-iam-permissions.md: 「Action required」を「必要な対応」に変更しました。
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly identifies the localization and terminology fixes in the TiDB Cloud BYOC documentation.
Description check Passed The description explains the scope, motivation, affected files, target release branch, related PRs, AI involvement, and change categories. It is complete for the required sections.
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: 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. (8 skipped: 8 unsupported.)

✨ 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/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 19, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 19, 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 csuzhangxc 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

Use 「AWS マネジメントコンソール」, the name AWS uses in Japanese and
the majority form in the docs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@yahonda
yahonda force-pushed the i18n-ja-fix-byoc-docs branch from a81acbe to 2bd8a84 Compare October 19, 2026 05:46
…C docs

The sync rendered "observability" both as 可観測性 and as
オブザーバビリティ in the BYOC docs. Use オブザーバビリティ, the form
commonly used in the industry, in all BYOC docs. The BYOC TOC entry
for the tiered storage observability page keeps 可観測性 to match that
page's title and the Premium TOC; other docs are left for a separate
change.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@yahonda
yahonda force-pushed the i18n-ja-fix-byoc-docs branch from 9182b8a to aa2a33a Compare October 19, 2026 06:11
@yahonda
yahonda marked this pull request as ready for review October 19, 2026 06:13
@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 19, 2026
…preparation doc

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

🔇 Additional comments: 3
tidb-cloud/byoc/create-resource-pool-byoc.md: 1

12-12: LGTM!

Also applies to: 47-47, 59-59

tidb-cloud/byoc/manage-resource-pools-byoc.md: 1

46-46: LGTM!

Also applies to: 68-68

tidb-cloud/byoc/byoc-prepare-environment-aws.md-130-137: 1

130-137: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

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

Translate the remaining table labels.

The column headers are Japanese, but the required-information table still uses English item names and example labels. Translate these user-facing labels while keeping AWS product names, IDs, and acronyms unchanged.

| **TiDB Cloud 組織 ID** | TiDB Cloud 組織の一意識別子 | `1372813089209270552` | ステップ 1 |
| **AWS アカウント ID** | 12 桁の AWS アカウント番号 | `123456789012` | ステップ 2 |
| **AWS リージョン** | デプロイ用に選択したリージョン | `us-west-2`, `us-east-1`, `us-east-2` | ステップ 3. マルチリージョン デプロイの場合は、すべてのリージョンを列挙してください。 |
| **アベイラビリティゾーン** | リージョンごとに 3 つの AZ または単一 AZ (名前と ID を指定) | **Us-east-1:** `us-east-1a`, `use1-az1`, `us-east-1b`, `use1-az2`, `us-east-1c`, `use1-az4`; **Us-east-2:** `us-east-2a`, `use2-az1`, `us-east-2b`, `use2-az2`, `us-east-2c`, `use2-az3`; **Us-west-2:** `us-west-2a`, `usw2-az1` | ステップ 3. 選択した**各**リージョンで AZ 数の要件を満たすよう注意してください。 |
| **下位 CA ARN** | AWS ACM Private CA ARN | `arn:aws:acm-pca:us-west-2:123456789012:ca/abcd-1234` | ステップ 5. この ARN は複数リージョンで共有できます。 |
| **ホストゾーン名とホストゾーン ID** | TiDB ホストゾーン。パブリックホストゾーンまたはプライベートホストゾーンのいずれかを指定できます。 | **TiDB ホストゾーン名:** `clusters.byoc-0929.pingcap.net`; **TiDB ホストゾーン ID:** `Z1039122VAY4T8UNWR8E`. | ステップ 4. ホストゾーンは複数リージョンで共有できます。 |
| **CIDR** | O11Y インフラストラクチャおよびリソースプール用にお客様が計画した CIDR 範囲 | **O11Y CIDR:** `10.1.0.0/22`; **リソースプール CIDR:** `10.10.0.0/16` | ステップ 6 |
| **イメージ同期リージョン** | イメージ同期用に選択したリージョン ID | `us-west-2` | 詳細は [イメージ同期](/tidb-cloud/byoc/byoc-automated-deployment.md#step-1-image-synchronization) を参照してください。 |

ℹ️ Review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 2597bfee-b65d-44f5-b365-5b85168c4776
📥 Commits

Reviewing files that changed from the base of the PR and between 748147e and 6cae83d.

📒 Files selected for processing: 13
  • TOC-tidb-cloud-byoc.md
  • tidb-cloud/byoc/byoc-automated-deployment.md
  • tidb-cloud/byoc/byoc-configure-bastion-host.md
  • tidb-cloud/byoc/byoc-configure-iam-permissions.md
  • tidb-cloud/byoc/byoc-initialize-service.md
  • tidb-cloud/byoc/byoc-onboarding-overview.md
  • tidb-cloud/byoc/byoc-prepare-environment-aws.md
  • tidb-cloud/byoc/create-resource-pool-byoc.md
  • tidb-cloud/byoc/create-tidb-instance-byoc.md
  • tidb-cloud/byoc/joint-validation.md
  • tidb-cloud/byoc/manage-resource-pools-byoc.md
  • tidb-cloud/byoc/multi-region-deployment.md
  • tidb-cloud/byoc/security-hardening.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.

Comment thread tidb-cloud/byoc/multi-region-deployment.md
Use 「MySQLシンクへ」, 「Kafkaシンクへ」, and 「クラウドストレージへ」,
as TOC-tidb-cloud.md does; the cloud storage page title is
「クラウドストレージへのシンク」.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
yahonda and others added 2 commits October 20, 2026 09:51
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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: 4

Caution

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

⚠️ Outside diff range comments (1)

🟡 Minor · Resolve the audit-log link check failure. · byoc-configure-bastion-host.md:180

tidb-cloud/byoc/byoc-configure-bastion-host.md:180
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Resolve the audit-log link check failure.

Lychee receives HTTP 403 for the Red Hat auditd link, so the Links workflow exits with code 2. The page is currently available, which indicates an automated-check access problem rather than a missing page. (docs.redhat.com) Use a checker-compatible official URL or update the link-check configuration for this host and status.

Source: Pipeline failures

🔇 Additional comments: 4
TOC-tidb-cloud-byoc.md: 2

62-62: LGTM!

Also applies to: 89-95, 112-117, 133-137, 149-151, 166-166, 180-186, 284-284, 372-372, 478-478, 493-499, 510-510


199-199: 🎯 Functional Correctness

The old #reference fragment must be checked before changing the heading. If a link uses that fragment, preserve an explicit #reference anchor or update the link.

tidb-cloud/byoc/byoc-onboarding-overview.md: 1

18-22: LGTM!

tidb-cloud/byoc/manage-resource-pools-byoc.md-68-68: 1

68-68: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

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

Pool vCPU Limit の対象を明確にしてください。

現在の文は、上限の対象と「任意」の意味を読み取りにくくします。Pool vCPU Limit が、リソースプールで許可されるプロビジョニング済み TiDB vCPU キャパシティの上限を顧客が定義する設定であることを明示してください。

コミット可能な修正
-Pool vCPU Limit は、リソースプールに対して許可される最大のプロビジョニング済み TiDB vCPU キャパシティについて、顧客が任意で定義できる上限です。管理ノードや可観測性ノードなどの追加 vCPU プロビジョニングは、この上限には含まれません。
+Pool vCPU Limit は、リソースプールで許可されるプロビジョニング済み TiDB vCPU キャパシティの上限を顧客が定義するための設定です。管理ノードや可観測性ノードなどの追加 vCPU プロビジョニングは、この上限に含まれません。

ℹ️ Review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 22209e2f-5d54-4c16-9bbc-286660d6e7a8
📥 Commits

Reviewing files that changed from the base of the PR and between 6cae83d and cba85c5.

📒 Files selected for processing: 8
  • TOC-tidb-cloud-byoc.md
  • tidb-cloud/byoc/byoc-automated-deployment.md
  • tidb-cloud/byoc/byoc-configure-bastion-host.md
  • tidb-cloud/byoc/byoc-initialize-service.md
  • tidb-cloud/byoc/byoc-onboarding-overview.md
  • tidb-cloud/byoc/byoc-prepare-environment-aws.md
  • tidb-cloud/byoc/joint-validation.md
  • tidb-cloud/byoc/manage-resource-pools-byoc.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.

Comment thread tidb-cloud/byoc/byoc-automated-deployment.md
Comment thread tidb-cloud/byoc/byoc-configure-bastion-host.md
Comment thread tidb-cloud/byoc/byoc-prepare-environment-aws.md
Comment thread tidb-cloud/byoc/byoc-prepare-environment-aws.md
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/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant