Skip to content

i18n(ja): unify notation in the TiDB Cloud docs - #24626

Merged
qiancai merged 21 commits into
pingcap:i18n-ja-release-8.5from
yahonda:i18n-ja-notation-sweep-tidb-cloud
Nov 16, 2026
Merged

qiancai merged 21 commits into
pingcap:i18n-ja-release-8.5from
yahonda:i18n-ja-notation-sweep-tidb-cloud

Conversation

@yahonda

@yahonda yahonda commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

This PR applies notation sweeps to the TiDB Cloud docs in tidb-cloud/ (129 files). These sweeps were already applied to the files of the JA PRs merged on 2026-11-03 (#24564-#24568, #24586, #24607); this PR covers files those PRs did not edit. Files that #24566 edits are not included. Each sweep is one commit, so the PR can be reviewed commit by commit.

  • Tier shortcodes: where the line-aligned English line writes {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, or {{{ .dedicated }}}, the Japanese line had the expanded product name (for example TiDB Cloud Starter). This PR uses the same shortcode. The rendered text does not change. Lines that do not match the English one to one are not changed. A summary: or title: value that starts with a shortcode is quoted, as in the English files. (86 files, 452 insertions(+), 452 deletions(-))

  • Spaces between katakana words, left over from machine translation, are removed outside code (for example パフォーマンス テスト → パフォーマンステスト). Spaces between Latin and Japanese text are not changed. (25 files, 38 insertions(+), 38 deletions(-))

  • The long vowel mark follows the 1991 Cabinet notice on loanword notation (外来語の表記, note 3): katakana words for English words ending in -er/-or/-ar end with ー (for example クラスター, パラメーター, オプティマイザー, フィルター). Words ending in -gy/-cy also take ー (トポロジー, like the existing ポリシー and レイテンシー). Derived -ing forms (フィルタリング, クラスタリング) and -ry/-ty words are not changed, except that the エントリー/プライマリー/セカンダリー outliers become エントリ/プライマリ/セカンダリ. Code, link targets, anchors, and HTML are not changed. Changed headings keep their {#...} anchors. (37 files, 91 insertions(+), 91 deletions(-))

  • Godan verbs: 「〜ことができます」 → the potential form (for example 読み取ることができます → 読み取れます, 行うことができます → 行えます). Ichidan verbs and causatives (切り替える, 見つける, 向上させる) keep 「〜ことができます」, because 「〜られる」 can also be read as passive. Verbs whose potential form is ambiguous or unnatural (開く, 進む, 含む, 知る, なる, 入る, 切る) are also kept. Text inside code is not changed. (3 files, 3 insertions(+), 3 deletions(-))

  • Line review fix: tidb-cloud/changefeed-overview.md "created after March 28, 2023" now says より後 (excludes the date), pairing with より前 on the next line.

  • Restore "~koto ga dekiru" where the godan potential form was followed by a comma (for example "行え、"), because that form reads as an imperative.

  • Keep "Recycle Bin" in English where the English source capitalizes it (the feature and page name, 26 places in 11 files, for example the glossary heading, "Restore from Recycle Bin", and the console maintenance notices). Where the English source uses lowercase "recycle bin", 「ごみ箱」 is kept. Heading anchors do not change.

  • Fixes for the sync in i18n-ja-release-8.5: translate doc changes from pingcap/docs release-8.5 on 2026-11-09 #24664 (one commit per file):

    • tidb-cloud/features.md: translate the new "(TiDB version: CLOUD.202603.x or later)" note in the manual backup row.
    • tidb-cloud/backup-and-restore-serverless.md: the last limitation no longer adds a cause that is not in the English source ("Each restore creates a new instance; restoring a manual backup to an existing instance is not supported.").
  • tidb-cloud/releases/release-notes-2025.md: keep the Azure region names (East US 2, Japan East, Southeast Asia) in English, as in the English source and in tidb-cloud-release-notes.md.

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 product references across TiDB Cloud guides and CLI documentation to use consistent plan names, and standardized Japanese terminology.
    • Clarified that point-in-time restore is unavailable for Starter and supports restoring to any point within the past 30 days for Essential.
    • Clarified that tiered-storage segment-size changes take effect at startup and require a rolling TiKV restart.
    • Clarified manual-backup restore limitations and updated references to the Recycle Bin.
    • Corrected an example describing foreign key relationships.
  • Release Notes
    • Added notes on query-planning and index optimizations, reduced coprocessor request bursts, and lower expression-buffer allocation for INSERT ... ON DUPLICATE KEY UPDATE.

yahonda and others added 4 commits November 4, 2026 09:09
Where the line-aligned English line writes {{{ .starter }}},
{{{ .essential }}}, {{{ .premium }}}, or {{{ .dedicated }}}, the
Japanese line had the expanded product name. Use the same shortcode.
The rendered text does not change. Lines that do not match the English
one to one are not changed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Spaces between katakana words, left over from machine translation, are
removed outside code. Spaces between Latin and Japanese text are kept.

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

Follow the 1991 Cabinet notice "Gairaigo no hyoki" (note 3): English
word-final -er/-or/-ar is written with the long vowel mark. Words ending
in -gy/-cy also take it (topology). Derived -ing forms and -ry/-ty
words are unchanged, except that the outliers for entry, primary, and
secondary drop the mark. Code, link targets, anchors, and HTML are not
touched.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Replace "<godan verb> + koto ga dekiru" with the potential form of the
verb. Ichidan verbs and causatives keep the can-form, because their
potential form can also be read as passive. Verbs whose potential form
is ambiguous or unnatural are also kept. Text inside code is not
changed.

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

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Explain Change →

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.

Walkthrough

This documentation update replaces fixed plan names with template labels and standardizes Japanese terminology across TiDB Cloud guides. It also updates Recycle Bin references and makes selected clarifications to backup, tiered-storage, schema, and release-note content.

Changes: TiDB Cloud documentation

Layer / File(s) Summary
Plan labels across guides
tidb-cloud/branch-*.md, tidb-cloud/cli-reference.md, tidb-cloud/connect-*.md, tidb-cloud/monitor-*.md, tidb-cloud/terraform-*.md, tidb-cloud/ticloud-*.md, tidb-cloud/*
Product names now use plan templates in branch, CLI, connection, monitoring, changefeed, Terraform, and other guides. The documented procedures, requirements, limits, and link destinations generally remain as stated.
Japanese terminology and navigation
tidb-cloud/byoc/*, tidb-cloud/configure-*.md, tidb-cloud/connected-*.md, tidb-cloud/premium/*, tidb-cloud/starter/*, tidb-cloud/*/_index.md
Japanese spelling and spacing are standardized across guides. Several navigation labels are updated without changing their destinations.
Backup, storage, schema, and release-note content
tidb-cloud/backup-and-restore*.md, tidb-cloud/delete-tidb-cluster.md, tidb-cloud/tiered-storage-faq.md, tidb-cloud/database-schema-concepts.md, tidb-cloud/releases/*
Backup guidance uses “Recycle Bin.” The manual-backup limitation is stated directly. The tiered-storage setting description adds startup and rolling-restart details. A schema example is corrected, and four TiDB X improvement items are added to a release note.

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

Change: Other

Suggested reviewers: qiancai

Merge Risk: Minimal · up to 3f174

No new functional issue was identified in the terminology changes. Rerun the failing checks before merging.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title "i18n(ja): unify notation in the TiDB Cloud docs" matches the main change. The PR applies Japanese notation sweeps across 129 files under tidb-cloud/. The sweeps include tier shortcode align…
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 PR description follows the repository template. It states what changed: notation sweeps across 129 files under tidb-cloud/, grouped into tier shortcodes, katakana space removal, long-vowel notatio…
Full details: Title check

Explanation

The title "i18n(ja): unify notation in the TiDB Cloud docs" matches the main change. The PR applies Japanese notation sweeps across 129 files under tidb-cloud/. The sweeps include tier shortcode alignment, katakana space removal, long-vowel standardization, and godan verb potential forms. The title names the scope and the type of change. It does not list every sweep, which is acceptable. The title is in English while the content is Japanese, which is consistent with the repository's i18n convention.

Full details: Description check

Explanation

The PR description follows the repository template. It states what changed: notation sweeps across 129 files under tidb-cloud/, grouped into tier shortcodes, katakana space removal, long-vowel notation, godan potential forms, and several targeted fixes. It names the target branch (i18n-ja-release-8.5), marks the AI agent involvement checkbox, and links related PRs #24586 and #24607. The template's version checkbox and the 'translated from' field are filled in or addressed. The description is detailed and matches the raw summary's file changes.

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

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 999299b and 3f17428.

Files selected for processing: 12

  • tidb-cloud/backup-and-restore-concepts.md
  • tidb-cloud/backup-and-restore-serverless.md
  • tidb-cloud/backup-and-restore.md
  • tidb-cloud/delete-tidb-cluster.md
  • tidb-cloud/features.md
  • tidb-cloud/premium/backup-and-restore-premium.md
  • tidb-cloud/premium/delete-tidb-instance.md
  • tidb-cloud/releases/notification-2023-08-31-console-maintenance.md
  • tidb-cloud/releases/notification-2023-09-26-console-maintenance.md
  • tidb-cloud/releases/notification-2024-09-15-console-maintenance.md
  • tidb-cloud/releases/tidb-cloud-release-notes.md
  • tidb-cloud/tidb-cloud-glossary.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.

@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 Nov 4, 2026
@ti-chi-bot

ti-chi-bot Bot commented Nov 4, 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 icemap 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

yahonda and others added 3 commits November 4, 2026 14:50
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…perative

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

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

Review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between f7f59b5 and 999299b.

Files selected for processing: 2
  • tidb-cloud/branch-overview.md
  • tidb-cloud/database-schema-concepts.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/database-schema-concepts.md Resolved
yahonda and others added 14 commits November 9, 2026 16:33
) into i18n-ja-notation-sweep-tidb-cloud

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…lizes it in backup-and-restore-serverless.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…lizes it in backup-and-restore.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…lizes it in delete-tidb-cluster.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…lizes it in backup-and-restore-premium.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…lizes it in delete-tidb-instance.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…lizes it in notification-2023-08-31-console-maintenance.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…lizes it in notification-2023-09-26-console-maintenance.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…lizes it in notification-2024-09-15-console-maintenance.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…lizes it in tidb-cloud-release-notes.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…lizes it in tidb-cloud-glossary.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…s in features.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…kup-and-restore-serverless.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Use the English Azure region names from the English source, matching
how tidb-cloud-release-notes.md already writes Japan East and East US 2.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@qiancai qiancai added the translation/no-need No need to translate this PR. label Nov 16, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Nov 16, 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 Nov 16, 2026
@ti-chi-bot

ti-chi-bot Bot commented Nov 16, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-11-16 09:05:15.615639694 +0000 UTC m=+1694240.240789969: ☑️ agreed by qiancai.

@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 commented Nov 16, 2026

Copy link
Copy Markdown

@qiancai: Your lgtm message is repeated, so it is ignored.

Details

In response to this:

LGTM

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@qiancai
qiancai merged commit 5166ac9 into pingcap:i18n-ja-release-8.5 Nov 16, 2026
6 of 10 checks passed
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/XXL Denotes a PR that changes 1000+ 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