Skip to content

i18n(ja): fix dropped particles before common action verbs - #23579

Open
yahonda wants to merge 6 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-dropped-particles-review-2026-08-20
Open

i18n(ja): fix dropped particles before common action verbs#23579
yahonda wants to merge 6 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-dropped-particles-review-2026-08-20

Conversation

@yahonda

@yahonda yahonda commented Aug 20, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Scanned the corpus for a high-confidence dropped-particle pattern: a closing code-span backtick, bracket, or parenthesis immediately followed (no space, no particle) by a common transitive action verb (設定します/して, 追加します/して, 選択します/して, 使用します/して, 確認します/して, 比較します/して, 変更します/して, 削除します/して, 入力します/して, 指定します/して, 表示します/して, 実行します/して, 作成します/して, クリックします/して). In Japanese, these verbs require a を particle marking their object, e.g. `X`設定します should be `X`を設定します ("configure/set X").

Verified a representative sample against the English source before applying: all confirmed genuine drops (e.g. "add X to the end of the file" -> Xを追加します, "directly selects Index_A" -> Index_Aを選択します).

Found and corrected 9 cases where the naive insertion created a double を, because the code span was in apposition to a noun already marked を earlier in the same clause (e.g. "監視項目をX追加します" = "add the monitoring item, X" - only one を needed, not two) or needed に instead of a second を (`region`を`US`に設定します = "set region TO US", not "region-WO US-WO").

Also fixed, found during manual review of the affected lines:

  • best-practices/tidb-best-practices.md: removed a redundant repeated word after a link ("[グローバルインデックス]インデックスでもある" -> "[グローバルインデックス]でもある"), matching the established leading/trailing-word-duplication defect class.
  • tidb-cloud/setup-azure-self-hosted-kafka-private-link-service.md: fixed a pre-existing bold/bracket straddling defect on the same line ("[サブスクリプション]" -> "[サブスクリプション]", "[名前]" -> "[名前]").

123 particle insertions across 79 files (net, after the 9 corrections and 2 bonus fixes). Verified 0 anomalies in line-count/backtick-count/[-count/]-count across all 76 changed files.

Scope note: this uses a specific, high-confidence heuristic (code-span/bracket immediately followed by one of these verbs with zero intervening characters). It is not an exhaustive review of every possible dropped particle in the corpus — other dropped-particle shapes (e.g. missing が/は, or drops not adjacent to a code span) are not covered here and would need separate detection heuristics.

Which TiDB version(s) do your changes apply to? (Required)

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

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference 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

Summary by CodeRabbit

  • Documentation
    • Corrected Japanese grammar, punctuation, spacing, and terminology across guides, FAQs, release notes, and configuration procedures.
    • Clarified setup, scaling, authentication, backup and restore, monitoring, replication, and troubleshooting instructions.
    • Improved descriptions of configuration examples, SQL procedures, alert resolution, and transaction ordering without changing commands, settings, functionality, or documented behavior.
    • Standardized sample city names and column headers in examples.
    • Added a clarifying link in the TiCDC documentation.

test and others added 2 commits August 20, 2026 11:26
- index-management-best-practices.md: added missing を particle
  ("...QUERY_TOTAL比較して" -> "...QUERY_TOTALを比較して"), matching
  EN "Compare X and Y".
- multi-column-index-best-practices.md: sample-data table headers
  said 市/寝室 (2 tables), inconsistent with the file's own prose
  which correctly uses 都市/寝室数 for the same EN "City"/"Bedrooms"
  columns.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Scanned the corpus for a high-confidence dropped-particle pattern:
a closing code-span backtick, bracket, or parenthesis immediately
followed (no space, no particle) by a common transitive action verb
(設定します/して, 追加します/して, 選択します/して, 使用します/して,
確認します/して, 比較します/して, 変更します/して, 削除します/して,
入力します/して, 指定します/して, 表示します/して, 実行します/して,
作成します/して, クリックします/して). In Japanese, these verbs
require a を particle marking their object, e.g. "`X`設定します"
should be "`X`を設定します" ("configure/set X").

Verified a representative sample against the English source before
and after applying: all confirmed genuine drops (e.g. "add `X` to
the end of the file" -> `X`を追加します, "directly selects `Index_A`"
-> `Index_A`を選択します).

Found and corrected 9 cases where the naive insertion created a
double を, because the code span was in apposition to a noun already
marked を earlier in the same clause (e.g. "監視項目を`X`追加します" =
"add the monitoring item, X" - only one を needed, not two) or needed
に instead of a second を ("`region`を`US`に設定します" = "set region
TO US", not "region-WO US-WO").

Also fixed, found during manual review of the affected lines:
- best-practices/tidb-best-practices.md: removed a redundant
  repeated word after a link ("[グローバルインデックス]インデックス
  でもある" -> "[グローバルインデックス]でもある"), matching the
  established leading/trailing-word-duplication defect class.
- tidb-cloud/setup-azure-self-hosted-kafka-private-link-service.md:
  fixed a pre-existing bold/bracket straddling defect on the same
  line ("**[サブスクリプ**ション]" -> "**[サブスクリプション]**",
  "[**名前]**" -> "**[名前]**").

123 particle insertions across 79 files (net, after the 9 corrections
and 2 bonus fixes). Verified 0 anomalies in line-count/backtick-count/
[-count/]-count across all 76 changed files.

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

ti-chi-bot Bot commented Aug 20, 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

@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Aug 20, 2026
@pingcap-cla-assistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


test seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@ti-chi-bot ti-chi-bot Bot added area/develop This PR relates to the area of TiDB App development. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 20, 2026
@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown

Review 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
📝 Walkthrough

Walkthrough

This pull request corrects Japanese documentation across guides, FAQs, configuration procedures, TiCDC and TiDB Cloud instructions, troubleshooting pages, examples, and historical release notes. It changes wording, grammar, punctuation, spacing, and sample labels only.

Changes

Documentation wording corrections

Layer / File(s) Summary
Guides, FAQs, product documentation, and examples
*.md, ai/guides/*.md, best-practices/*.md, clinic/*.md, faq/*.md, ticdc/*.md, tidb-cloud/*.md, tiup/*.md
Japanese grammar, particles, punctuation, spacing, configuration instructions, and sample table labels are corrected. Documented commands, settings, procedures, and behavior remain unchanged.
Release-note wording
releases/*.md
Japanese release-note entries are corrected for grammar and wording. Documented features, configuration values, and references remain unchanged.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: 🟡 Moderate · up to 9df1c

The PR improves Japanese documentation across many files, but the current head still contains unresolved instructions that could lead users to invalid Terraform settings, incorrect configuration guidance, or misleading routing behavior, along with several localized clarity and formatting issues. Merge should wait for these concrete documentation issues to be corrected or explicitly accepted.

Possibly related PRs

  • pingcap/docs#23563: Overlaps in Japanese documentation fixes, including several of the same files.

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the primary change: fixing omitted Japanese particles before common action verbs.
Description check ✅ Passed The description explains the changes, scope, validation, affected version, AI involvement, and applicable change categories.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

This doc's SQL examples use literal string values 'San Francisco',
'San Diego', and 'New York' (e.g. WHERE city = 'San Francisco'), and
the prose repeatedly references the actual column names `city`,
`bedrooms`, `price` with backticks. The sample-data tables and prose
city-name mentions had been translated to katakana (都市/寝室数/価格
headers, サンディエゴ/サンフランシスコ/ニューヨーク), creating a
mismatch between the explanation and the runnable SQL/output it
describes.

Restored to English to match the code, per the same reasoning as
PR pingcap#23562 (sample data values that appear in code must match the
code, not be translated): table headers (City/Bedrooms/Price) and
data values (San Diego/San Francisco) in both sample-data tables,
and the specific city-name mentions in prose (San Francisco, San
Diego, New York) that correspond to the same literal values used in
the SQL query examples. Generic uses of 都市 as a concept (not a
specific city name) were left untouched.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@ti-chi-bot ti-chi-bot Bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 20, 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.

Actionable comments posted: 31


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 1d496976-e553-476a-ace9-bbdd848c92a2

📥 Commits

Reviewing files that changed from the base of the PR and between b0387bb and d8abef1.

📒 Files selected for processing (79)
  • accelerated-table-creation.md
  • ai/guides/auto-embedding.md
  • ai/guides/vector-search.md
  • alert-rules.md
  • best-practices/ddl-introduction.md
  • best-practices/index-management-best-practices.md
  • best-practices/multi-column-index-best-practices.md
  • best-practices/pd-scheduling-best-practices.md
  • best-practices/tidb-best-practices.md
  • br/br-incremental-guide.md
  • check-before-deployment.md
  • clinic/clinic-user-guide-for-tiup.md
  • clinic/quick-start-with-clinic.md
  • cost-model.md
  • dashboard/dashboard-session-sso.md
  • develop/dev-guide-schema-design-overview.md
  • dm/dm-online-ddl-tool-support.md
  • dr-multi-replica.md
  • dr-secondary-cluster.md
  • faq/backup-and-restore-faq.md
  • faq/deploy-and-maintain-faq.md
  • faq/migration-tidb-faq.md
  • faq/upgrade-faq.md
  • hybrid-deployment-topology.md
  • optimizer-fix-controls.md
  • performance-tuning-methods.md
  • releases/release-2.1-beta.md
  • releases/release-2.1-ga.md
  • releases/release-2.1-rc.3.md
  • releases/release-2.1.15.md
  • releases/release-3.0-beta.md
  • releases/release-3.0-ga.md
  • releases/release-3.0.0-beta.1.md
  • releases/release-3.0.0-rc.1.md
  • releases/release-3.0.1.md
  • releases/release-3.0.3.md
  • releases/release-3.0.4.md
  • releases/release-4.0.12.md
  • releases/release-4.0.2.md
  • releases/release-4.0.3.md
  • releases/release-5.0.0-rc.md
  • releases/release-5.0.6.md
  • releases/release-6.3.0.md
  • releases/release-6.5.9.md
  • releases/release-7.1.5.md
  • releases/release-7.4.0.md
  • releases/release-7.5.2.md
  • scale-tidb-using-tiup.md
  • security-compatibility-with-mysql.md
  • sql-statements/sql-statement-alter-table-compact.md
  • sql-statements/sql-statement-savepoint.md
  • storage-engine/titan-configuration.md
  • sync-diff-inspector/route-diff.md
  • ticdc/deploy-ticdc.md
  • ticdc/integrate-confluent-using-ticdc.md
  • ticdc/ticdc-bidirectional-replication.md
  • ticdc/ticdc-client-authentication.md
  • ticdc/ticdc-faq.md
  • ticdc/ticdc-open-protocol.md
  • ticdc/troubleshoot-ticdc.md
  • tidb-cloud/monitor-new-relic-integration.md
  • tidb-cloud/scale-tidb-cluster.md
  • tidb-cloud/serverless-private-link-connection-to-amazon-msk.md
  • tidb-cloud/set-up-private-endpoint-connections.md
  • tidb-cloud/setup-azure-self-hosted-kafka-private-link-service.md
  • tidb-cloud/terraform-use-cluster-resource.md
  • tidb-cloud/terraform-use-dedicated-cluster-resource.md
  • tidb-cloud/terraform-use-import-resource.md
  • tidb-cloud/terraform-use-restore-resource.md
  • tidb-cloud/ticloud-serverless-spending-limit.md
  • tidb-performance-tuning-config.md
  • tiflash/tiflash-configuration.md
  • tiflash/tiflash-disaggregated-and-s3.md
  • tikv-control.md
  • tiproxy/tiproxy-load-balance.md
  • tiup/customized-montior-in-tiup-environment.md
  • tiup/tiup-cluster-no-sudo-mode.md
  • transaction-overview.md
  • troubleshoot-data-inconsistency-errors.md

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

Comment thread best-practices/index-management-best-practices.md
Comment thread best-practices/pd-scheduling-best-practices.md
Comment thread br/br-incremental-guide.md Outdated
Comment thread clinic/clinic-user-guide-for-tiup.md Outdated
Comment thread clinic/clinic-user-guide-for-tiup.md Outdated
Comment thread tidb-cloud/terraform-use-cluster-resource.md
Comment thread tidb-cloud/terraform-use-dedicated-cluster-resource.md
Comment thread tiflash/tiflash-configuration.md Outdated
Comment thread tiflash/tiflash-disaggregated-and-s3.md Outdated
Comment thread tiup/customized-montior-in-tiup-environment.md

@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

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 55911f12-1437-4948-a860-7d6ed5bf5721

📥 Commits

Reviewing files that changed from the base of the PR and between d8abef1 and 26a7825.

📒 Files selected for processing (1)
  • best-practices/multi-column-index-best-practices.md

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Comment thread best-practices/multi-column-index-best-practices.md Outdated
Applied 22 of CodeRabbit's flagged issues after verifying each
against the English source: dropped particles (を/に/は/の) in
br-incremental-guide.md, clinic docs (plus 2 more instances found in
both clinic files during the same review pass, not originally
flagged), dm-online-ddl-tool-support.md, upgrade-faq.md,
performance-tuning-methods.md (also fixing a duplicated "RaftRaft
Engine"), several release notes files, scale-tidb-using-tiup.md,
sql-statement-alter-table-compact.md, ticdc-faq.md (x2),
tiflash-disaggregated-and-s3.md; a garbled table cell in
hybrid-deployment-topology.md (also fixing a second missing を on an
adjacent line found while there); a reversed CREATE TABLE/PRIMARY KEY
syntax description in dev-guide-schema-design-overview.md; a garbled
two-value configuration example in tiflash-configuration.md; an
incorrect filter description in multi-column-index-best-practices.md
that made a price limit read as a bedroom-count limit; and a broken
link/verb pairing in scale-tidb-cluster.md.

Declined 9 of CodeRabbit's suggestions after EN verification showed
they were false positives or out of scope:
- MD030 list-marker-spacing (2 threads) - established convention,
  matches EN source spacing.
- release-4.0.12.md's "知ることができるように" wording - a valid
  rendering of EN's "to help users know", not a grammar defect.
- release-5.0.0-rc.md's 変更→設定 suggestion - EN literally says
  "modifying `enable-cross-table-merge = true`", so 変更 is correct.
- route-diff.md's schema/database suggestion - EN itself uses "table"
  for both terms in this exact sentence; JA already matches EN and
  is internally consistent with the same file's other occurrence.
- monitor-new-relic-integration.md's link-text suggestion - EN's own
  link text is the literal generic word "link", which JA already
  matches.
- terraform-use-cluster-resource.md / terraform-use-dedicated-
  cluster-resource.md's pause/paused inconsistency - EN itself has
  the identical inconsistency (instruction text says "pause = true"
  while the code example shows "paused = true"); JA correctly
  mirrors it.
- customized-montior-in-tiup-environment.md's field/value reversal
  claim - the current JA text already correctly matches EN's "set
  `rule_dir`/`dashboard_dir` to the directory" structure.

Verified 0 anomalies in line-count/backtick-count/[-count/]-count
across all 22 changed files.

Co-Authored-By: Claude Sonnet 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: 5


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 282e0d5a-66af-4a7f-b2e2-8a5034439c75

📥 Commits

Reviewing files that changed from the base of the PR and between 26a7825 and 9df1c59.

📒 Files selected for processing (22)
  • best-practices/multi-column-index-best-practices.md
  • br/br-incremental-guide.md
  • clinic/clinic-user-guide-for-tiup.md
  • clinic/quick-start-with-clinic.md
  • develop/dev-guide-schema-design-overview.md
  • dm/dm-online-ddl-tool-support.md
  • faq/upgrade-faq.md
  • hybrid-deployment-topology.md
  • performance-tuning-methods.md
  • releases/release-2.1-ga.md
  • releases/release-2.1-rc.3.md
  • releases/release-3.0.0-rc.1.md
  • releases/release-3.0.4.md
  • releases/release-4.0.3.md
  • releases/release-5.0.0-rc.md
  • releases/release-5.0.6.md
  • scale-tidb-using-tiup.md
  • sql-statements/sql-statement-alter-table-compact.md
  • ticdc/ticdc-faq.md
  • tidb-cloud/scale-tidb-cluster.md
  • tiflash/tiflash-configuration.md
  • tiflash/tiflash-disaggregated-and-s3.md

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

Comment thread dm/dm-online-ddl-tool-support.md
Comment thread hybrid-deployment-topology.md Outdated
Comment thread hybrid-deployment-topology.md
Comment thread tiflash/tiflash-configuration.md Outdated
Comment thread tiflash/tiflash-disaggregated-and-s3.md Outdated
…iew pass

- hybrid-deployment-topology.md: table cell was missing the "1." step
  number (steps 2-4 were numbered but step 1 wasn't), matching EN's
  "1. Separate the instance-level port and status_port; 2. ...".
- tiflash-configuration.md: "storage.latest.dirという容量" (the
  capacity "called" storage.latest.dir) was a mistranslation of EN's
  "the capacity of storage.latest.dir" (i.e. capacity allocated TO
  that directory); changed という容量 to に割り当てる容量.
- tiflash-disaggregated-and-s3.md: JA was missing EN's "on all
  machines where TiFlash processes are deployed" clause entirely.

Declined 2 other findings from the same review after EN verification:
- dm-online-ddl-tool-support.md's "(同時に)" parenthetical placement -
  EN itself has the identical awkward placement ("the upstream
  MySQL/MariaDB (at the same time) uses..."), so JA is a faithful
  translation, not a JA-only error.
- hybrid-deployment-topology.md's readpool.storage/coprocessor naming
  suggestion - EN says "Enable `readpool.storage` and
  `readpool.coprocessor`:", which the current short field names
  already match; CodeRabbit's suggested full dotted names aren't in
  EN.

Co-Authored-By: Claude Sonnet 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 Aug 20, 2026
# Conflicts:
#	ticdc/integrate-confluent-using-ticdc.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/develop This PR relates to the area of TiDB App development. size/XL Denotes a PR that changes 500-999 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