Skip to content

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

Open
yahonda wants to merge 2 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 2 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.

@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

pingcap-cla-assistant Bot commented Aug 20, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@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.

@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 Outdated
Comment thread best-practices/pd-scheduling-best-practices.md Outdated
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 Outdated
Comment thread tidb-cloud/terraform-use-dedicated-cluster-resource.md Outdated
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 Outdated

@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

@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 Outdated
Comment thread hybrid-deployment-topology.md Outdated
Comment thread hybrid-deployment-topology.md Outdated
Comment thread tiflash/tiflash-configuration.md Outdated
Comment thread tiflash/tiflash-disaggregated-and-s3.md Outdated
@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
@yahonda
yahonda marked this pull request as draft August 24, 2026 02:08
@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 Aug 24, 2026
@yahonda
yahonda force-pushed the fix-dropped-particles-review-2026-08-20 branch from aa2efb0 to c283d04 Compare August 24, 2026 02:23
@yahonda
yahonda marked this pull request as ready for review August 24, 2026 03:02
@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 Aug 24, 2026
@yahonda
yahonda force-pushed the fix-dropped-particles-review-2026-08-20 branch 2 times, most recently from 3301940 to 4cc1649 Compare August 26, 2026 01:54
yahonda added a commit that referenced this pull request Aug 27, 2026
55 sites across 51 files where the topic particle は appears to be
missing immediately after a code span/bracket, before a definitional
or state predicate (becomes/is called/represents/corresponds to/is
supported/etc.).

NOT individually verified against the English source per-site, unlike
the previous を (#23579/#23611) and が (#23624) sweeps. は is far more
context-dependent than を/が (Japanese frequently and correctly omits
は when a topic is already established), so a mechanical detector has
a much higher false-positive rate here. Submitted as a draft
specifically so a human can review each site before merging.

UPDATE: user review caught a systemic false-positive class in the
になります/となります predicate category (18 sites) -- the captured
code span/bracket is the COMPLEMENT (the resulting value) of the
"becomes X" predicate, not its subject, e.g. "この機能が一般提供
(GA)となります" (the feature becomes GA) mis-edited to insert は
right before となります, producing the ungrammatical "一般提供(GA)
はとなります". All 18 sites in this predicate category were reverted;
37 sites across the other predicate categories remain.
Rebased onto i18n-ja-release-8.5 after pingcap#23602 merged the markdownlint
conformance fixes and after pingcap#23577's katakana compound-word joins.
Re-verified and restored 8 katakana joins that had been silently
reverted by the initial content-preserving merge on lines this branch
also touched, using an independent scan comparing spaced-katakana
runs in the result against upstream's already-joined form.
@yahonda
yahonda force-pushed the fix-dropped-particles-review-2026-08-20 branch from 4cc1649 to 72420e8 Compare August 27, 2026 04:31
…l-fix-dropped-particles-review-2026-08-20

# Conflicts:
#	dr-multi-replica.md
#	faq/upgrade-faq.md
#	performance-tuning-methods.md
#	releases/release-3.0-beta.md
#	tiproxy/tiproxy-load-balance.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