Skip to content

i18n(ja): fix particles/punctuation trapped inside bold spans across corpus - #23765

Open
yahonda wants to merge 2 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-bold-span-trapped-particle
Open

i18n(ja): fix particles/punctuation trapped inside bold spans across corpus#23765
yahonda wants to merge 2 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-bold-span-trapped-particle

Conversation

@yahonda

@yahonda yahonda commented Sep 8, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Corpus-wide fix for a bold-span markup defect: a Japanese grammatical particle (が/を/に/は/も/と/etc.), sometimes with trailing punctuation, was trapped inside the closing ** of a bold span instead of falling outside it, where EN's own bold boundary ends. This was found while manually reviewing a specific instance in best-practices/ddl-introduction.md, then swept across the whole i18n-ja-release-8.5 corpus by pattern-matching bold spans ending in a particle and verifying each candidate against the EN source (release-8.5) before fixing.

36 files, 58 sites fixed. Only the ** marker position was moved in each case — no wording or translation content was changed. Several dozen additional candidates were reviewed and left untouched because they were false positives (particle is part of a fixed grammatical construction like 〜しないでください, or EN's own bold scope genuinely includes the trailing word).

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 wording, grammar, and Markdown emphasis across benchmark reports, guides, troubleshooting content, glossary entries, and TiDB Cloud documentation.
    • Clarified phantom-read examples, TiKV node requirements, SQL terminology, and selected release-note descriptions.
    • Added manual IAM role setup guidance and a security recommendation for reducing maximum session duration in Amazon S3 documentation.
  • Style
    • Standardized bold formatting and link presentation so labels, parameters, and key terms render consistently.

@ti-chi-bot ti-chi-bot Bot added area/develop This PR relates to the area of TiDB App development. missing-translation-status This PR does not have translation status info. labels Sep 8, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 8, 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

@ti-chi-bot ti-chi-bot Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 8, 2026
@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

📝 Walkthrough

Walkthrough

This documentation-only change corrects Japanese wording, punctuation, and Markdown emphasis across benchmark, TiDB, DM, TiDB Cloud, troubleshooting, and release documents. It changes no public entities or software behavior.

Changes

Japanese documentation corrections

Layer / File(s) Summary
General documentation corrections
benchmark/*, develop/*, dm/*, deploy-monitoring-services.md, dumpling-overview.md, information-schema/*, runtime-filter.md, tidb-troubleshooting-map.md, troubleshoot-write-conflicts.md, tune-tikv-thread-performance.md
Corrects Japanese wording and Markdown emphasis boundaries in general documentation.
TiDB Cloud documentation corrections
external-storage-uri.md, tidb-cloud/branch-manage.md, tidb-cloud/changefeed-*, tidb-cloud/data-service-*, tidb-cloud/migrate-*, tidb-cloud/serverless-*, tidb-cloud/set-up-*, tidb-cloud/size-your-cluster.md, tidb-cloud/tidb-cloud-auditing.md, tidb-cloud/tidb-x-architecture.md, tidb-cloud/top-ru.md
Corrects Japanese wording, link and button formatting, permission text, and emphasis boundaries.
Release note corrections
releases/*, tidb-cloud/releases/*
Corrects Japanese wording and Markdown emphasis in current and historical release notes.

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

Change: Other

Merge Risk: 🔵 Low · up to 11008

The Japanese phantom-read example may mislead readers about why a repeated query returns additional rows. Clarifying that modified rows become query matches would make the documented behavior accurate before merge.

Possibly related PRs

  • pingcap/docs#23641: Corrects Japanese Markdown emphasis and particle placement in overlapping documentation files.
  • pingcap/docs#23559: Corrects Japanese particle placement and Markdown emphasis across similar documentation files.
  • pingcap/docs#23552: Corrects Japanese Markdown formatting around UI labels and particles.

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the corpus-wide Japanese bold-span boundary fixes, including the affected particles and punctuation.
Description check ✅ Passed The description explains the scope, motivation, validation against the English source, affected files and sites, target version, AI involvement, and unchanged checklist items. It provides the required…
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.
✨ 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.

@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: 3


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 09b4d5bb-0244-4ced-a6fe-8930a28ec9d0

📥 Commits

Reviewing files that changed from the base of the PR and between 32db0cb and 3f99de0.

📒 Files selected for processing (36)
  • benchmark/online-workloads-and-add-index-operations.md
  • benchmark/v4.0-performance-benchmarking-with-tpch.md
  • deploy-monitoring-services.md
  • develop/dev-guide-aws-appflow-integration.md
  • develop/dev-guide-create-table.md
  • develop/dev-guide-tidb-basics.md
  • develop/dev-guide-timeouts-in-tidb.md
  • develop/dev-guide-transaction-restraints.md
  • dm/dm-glossary.md
  • dm/dm-replication-logic.md
  • dm/dm-webui-guide.md
  • dumpling-overview.md
  • external-storage-uri.md
  • information-schema/information-schema-deadlocks.md
  • releases/release-7.0.0.md
  • releases/release-8.5.4.md
  • runtime-filter.md
  • tidb-cloud/branch-manage.md
  • tidb-cloud/changefeed-sink-to-apache-kafka.md
  • tidb-cloud/changefeed-sink-to-apache-pulsar.md
  • tidb-cloud/data-service-manage-data-app.md
  • tidb-cloud/essential-changefeed-sink-to-kafka.md
  • tidb-cloud/migrate-from-mysql-using-data-migration.md
  • tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration.md
  • tidb-cloud/releases/release-notes-2023.md
  • tidb-cloud/releases/tidb-cloud-release-notes.md
  • tidb-cloud/serverless-private-link-connection-to-amazon-msk.md
  • tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md
  • tidb-cloud/set-up-private-endpoint-connections-on-azure.md
  • tidb-cloud/size-your-cluster.md
  • tidb-cloud/tidb-cloud-auditing.md
  • tidb-cloud/tidb-x-architecture.md
  • tidb-cloud/top-ru.md
  • tidb-troubleshooting-map.md
  • troubleshoot-write-conflicts.md
  • tune-tikv-thread-performance.md

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

Comment thread develop/dev-guide-transaction-restraints.md Outdated
Comment thread dm/dm-replication-logic.md Outdated
Comment thread tidb-cloud/branch-manage.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 Sep 8, 2026
Address CodeRabbit review comments on PR pingcap#23765.

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: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 18a198f4-404b-4706-973b-790e8474b340

📥 Commits

Reviewing files that changed from the base of the PR and between 3f99de0 and 110082b.

📒 Files selected for processing (3)
  • develop/dev-guide-transaction-restraints.md
  • dm/dm-replication-logic.md
  • tidb-cloud/branch-manage.md

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

Comment thread develop/dev-guide-transaction-restraints.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/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