Skip to content

i18n(ja): fix TiDB Cloud Premium docs found in the second full review - #24555

Merged
qiancai merged 4 commits into
pingcap:i18n-ja-release-8.5from
yahonda:i18n-ja-fix-tidb-cloud-premium-2nd-review
Oct 27, 2026
Merged

qiancai merged 4 commits into
pingcap:i18n-ja-release-8.5from
yahonda:i18n-ja-fix-tidb-cloud-premium-2nd-review

Conversation

@yahonda

@yahonda yahonda commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

This PR fixes the Japanese TiDB Cloud Premium docs under tidb-cloud/premium/ after a second line-by-line review against the English source (release-8.5 at 6fa2484). The review covered all 22 files in tidb-cloud/premium/, tidb-cloud/dedicated/, and tidb-cloud/essential/; only premium/ files needed changes. All code blocks already match the English, and commands, URLs, and link targets are unchanged.

  • Sync lag: the English titles and H1s now include {{{ .byoc }}}. The title:, summary:, and H1 anchors are updated to match.
  • Mistranslations and omissions:
    • "If it is successful," was missing before The connection is successful.
    • "deleted instances in the Recycle Bin" could be read as "deleted from the Recycle Bin".
    • The Private Data Link pricing sentence duplicated each service name and reversed "X of [pricing]".
    • "Maintain key availability" was 「管理」.
  • Bold UI labels that had been translated are restored to English: Region, Zone, Other Endpoint Services, Identities, Switch to Policy Editor. The metrics tab headings in built-in-monitoring-premium.md are now Overview, Database, and Advanced, as in built-in-monitoring.md.
  • Leftover English is translated: name tag, security group, inbound access, public/private hosted zone, "TiDB Cloud console", "Help Center", and link texts that copy Japanese page titles.
  • A translated <!--Todo-- ...--> HTML comment is restored to the English.
  • One rendering per term:
    • Dual-Layer Data Encryption → 二重層データ暗号化 (the H1 and TOC form)
    • log redaction → ログの秘匿化
    • role → ロール, attach → アタッチ, region → リージョン, retention period → 保持期間, private key → 秘密鍵
    • 「ステップ N. 」 step headings with a half-width period
    • premium/_index.md link texts now match dedicated/_index.md and essential/_index.md
  • Readability: headings that ended in 「〜します」 now use the 「〜する」 form. Anchors are unchanged.

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 guides with revised terminology, headings, link labels, and step-by-step instructions for connectivity, backups and restores, imports, encryption, monitoring, auditing, and billing.
    • Clarified which guides cover TiDB Cloud Premium and BYOC instances, and refined descriptions of restore procedures, backup retention, monitoring metrics, and cloud-provider configuration.
    • No changes were made to product behavior, feature conditions, or pricing.

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

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

coderabbitai Bot commented Oct 27, 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 4676e56 and 3ff2ba0.

Files selected for processing: 2
  • tidb-cloud/premium/create-tidb-instance-premium.md
  • tidb-cloud/premium/migrate-from-op-tidb-premium.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.

Walkthrough

This PR revises Japanese TiDB Cloud Premium documentation across navigation, BYOC coverage, backup and connection instructions, security and monitoring terminology, and import and export guidance. It updates selected headings, anchors, link labels, and descriptions. The documented procedures and conditions are generally unchanged.

Changes: Premium documentation

Layer / File(s) Summary
BYOC coverage and navigation
tidb-cloud/premium/_index.md, tidb-cloud/premium/configure-ip-access-list-premium.md, tidb-cloud/premium/connect-to-tidb-instance.md, tidb-cloud/premium/delete-tidb-instance.md, tidb-cloud/premium/import-from-s3-premium.md, tidb-cloud/premium/migrate-from-op-tidb-premium.md, tidb-cloud/premium/premium-export.md, tidb-cloud/premium/tidb-cloud-billing-ticdc-ccu.md
Titles, anchors, and navigation text identify Premium and BYOC coverage. Billing link labels change; the price remains $0.01/GiB.
Backup, restore, and instance lifecycle
tidb-cloud/premium/backup-and-restore-premium.md, tidb-cloud/premium/delete-tidb-instance.md
Restore wording and localized BYOC links change. The instance-deletion page revises retention wording while retaining the seven-day default and automatic deletion.
Connection and private endpoint guidance
tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-private-endpoint.md, tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md, tidb-cloud/premium/connect-to-premium-via-public-connection.md, tidb-cloud/premium/set-up-sink-private-endpoint-premium.md
Connection instructions update Japanese terms, headings, and selected console labels. Endpoint steps and stated port conditions remain unchanged.
Security, audit, and monitoring terminology
tidb-cloud/premium/built-in-monitoring-premium.md, tidb-cloud/premium/dual-layer-data-encryption-premium.md, tidb-cloud/premium/tidb-cloud-auditing-premium.md, tidb-cloud/premium/tidb-cloud-tls-connect-to-premium.md
These pages revise terminology and selected labels. Audit descriptions retain their stated defaults and conditions.
Import, migration, and export instructions
tidb-cloud/premium/import-csv-files-premium.md, tidb-cloud/premium/import-from-s3-premium.md, tidb-cloud/premium/import-with-mysql-cli-premium.md, tidb-cloud/premium/migrate-from-op-tidb-premium.md, tidb-cloud/premium/premium-export.md
Import, migration, and export pages revise link labels, headings, anchors, and selected descriptions. The export page retains its request-based process.
Instance creation wording
tidb-cloud/premium/create-tidb-instance-premium.md
Registration wording changes in English- and Chinese-language content and Japanese-language content.

Priority: Low

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

Change: Other

Possibly related issues

Suggested reviewers: qiancai

Merge Risk: Minimal · up to 3ff2b

The documentation-only wording and anchor updates are mergeable with no identified user-impacting risk.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly identifies the Japanese TiDB Cloud Premium documentation fixes and their review context.
Description check Passed The description explains the documentation scope, changes, affected version, source link, AI involvement, and applicability checklist. The omitted first-time contributor checklist is optional, and the…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi…
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 explains the documentation scope, changes, affected version, source link, AI involvement, and applicability checklist. The omitted first-time contributor checklist is optional, and the version branch is appropriate for this localization PR.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (2 skipped: 2 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 commented Oct 27, 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 breezewish 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

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 27, 2026
@yahonda
yahonda marked this pull request as ready for review October 27, 2026 06:21
@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 27, 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/premium/dual-layer-data-encryption-premium.md-73-73: 1

73-73: Trivial · Maintainability & Code Quality · Quick win

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

冗長な表現を簡潔にしてください。

「有効にすることができます」は「有効にできます」と書けます。次の置換を適用してください。

TiDB Cloud Premiumインスタンスを作成する際、またはインスタンス作成後に、二重層データ暗号化を有効にできます。

As per path instructions, this Markdown fix uses a committable suggestion; the static analysis hint identifies 「ことができる」 as potentially redundant.

Sources: Path instructions, Linters/SAST tools


Review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 4de2d0f and 1da4b3b.

Files selected for processing: 19
  • tidb-cloud/premium/_index.md
  • tidb-cloud/premium/backup-and-restore-premium.md
  • tidb-cloud/premium/built-in-monitoring-premium.md
  • tidb-cloud/premium/configure-ip-access-list-premium.md
  • tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-private-endpoint.md
  • tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md
  • tidb-cloud/premium/connect-to-premium-via-public-connection.md
  • tidb-cloud/premium/connect-to-tidb-instance.md
  • tidb-cloud/premium/delete-tidb-instance.md
  • tidb-cloud/premium/dual-layer-data-encryption-premium.md
  • tidb-cloud/premium/import-csv-files-premium.md
  • tidb-cloud/premium/import-from-s3-premium.md
  • tidb-cloud/premium/import-with-mysql-cli-premium.md
  • tidb-cloud/premium/migrate-from-op-tidb-premium.md
  • tidb-cloud/premium/premium-export.md
  • tidb-cloud/premium/set-up-sink-private-endpoint-premium.md
  • tidb-cloud/premium/tidb-cloud-auditing-premium.md
  • tidb-cloud/premium/tidb-cloud-billing-ticdc-ccu.md
  • tidb-cloud/premium/tidb-cloud-tls-connect-to-premium.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 27, 2026 15:51
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…encryption doc

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@qiancai qiancai added translation/no-need No need to translate this PR. and removed missing-translation-status This PR does not have translation status info. labels Oct 27, 2026

@qiancai qiancai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@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 12:10:14.98315589 +0000 UTC m=+463352.474868169: ☑️ agreed by qiancai.

@qiancai
qiancai merged commit 1ab23c8 into pingcap:i18n-ja-release-8.5 Oct 27, 2026
6 of 10 checks passed
@yahonda
yahonda deleted the i18n-ja-fix-tidb-cloud-premium-2nd-review branch October 28, 2026 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants