Skip to content

i18n(ja): fix particle/punctuation trapped inside bold spans - #23641

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

i18n(ja): fix particle/punctuation trapped inside bold spans#23641
yahonda wants to merge 2 commits into
i18n-ja-release-8.5from
fix-bold-span-particle-boundary

Conversation

@yahonda

@yahonda yahonda commented Aug 28, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Found via a corpus-wide scan for bold spans (**...**) whose content starts with a Japanese comma, period, or particle character (//), where EN's own bold boundary excludes it — e.g. EN "This section provides a detailed description of these key metrics on the TiKV-Details dashboard" bolds only the product name, not a preceding comma, while the JA rendering had このセクションでは**、TiKV-Details**ダッシュボード (comma trapped inside).

24 files, 27 sites. Most fixes move the leading punctuation/particle outside the bold span, preserving content. A few sites needed a larger fix where the bold content had been reduced to just a bare punctuation mark with the actual emphasized word missing or misplaced nearby:

  • tidb-cloud/essential-changefeed-overview.md, essential-changefeed-sink-to-kafka.md, essential-changefeed-sink-to-mysql.md: EN bolds the ? character itself (click **?**); JA had lost the bold on ? and left a duplicated trailing period instead.
  • tidb-cloud/top-ru.md: EN separately bolds three numbers (**5**, **20**, and **100**); JA had collapsed them into one bold span with commas trapped inside, plus an unrelated extra bold on "instance" that EN doesn't bold at all.
  • tidb-cloud/configure-external-storage-access.md: a trailing (possessive particle) was trapped inside the closing ** of an S3 permission name.
  • develop/dev-guide-update-data.md: a triple-asterisk (bold+italic) span wrapping a leading comma, where EN has no emphasis at all at that position — removed the formatting entirely to match.

Each site was individually checked against its corresponding EN sentence before fixing, rather than applying one blanket "move the comma" rule (mirroring the lesson from a similar sweep on [[ja-term-target-selection]]: check every site's own exact EN text).

Verified markdownlint-cli2 clean on all touched files.

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 formatting, punctuation, grammar, and typography across guides, references, dashboards, and TiDB Cloud materials.
    • Clarified reverse proxy guidance for preserving and serving the /dashboard/ path.
    • Updated Ruby on Rails TLS connection guidance for TiDB Cloud Starter and Essential.
    • Corrected unique key recommendations for INSERT ON DUPLICATE KEY UPDATE.
    • Improved emphasis for permissions, settings, metrics, interface icons, and product names.

@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 Aug 28, 2026
@ti-chi-bot

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

@ti-chi-bot ti-chi-bot Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 28, 2026
@coderabbitai

coderabbitai Bot commented Aug 28, 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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 0e4f2c27-5dc6-4691-b3f0-bf53f3e449c4

📥 Commits

Reviewing files that changed from the base of the PR and between a5335f9 and 1d5b489.

📒 Files selected for processing (1)
  • develop/dev-guide-create-table.md

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


📝 Walkthrough

Walkthrough

This documentation-only change corrects Japanese Markdown emphasis, punctuation, spacing, grammar, and wording across TiDB, DM, TiCDC, dashboard, and TiDB Cloud pages. Documented functionality and requirements remain unchanged.

Changes

Documentation formatting corrections

Layer / File(s) Summary
Core TiDB documentation corrections
best-practices/..., column-privilege-management.md, dashboard/dashboard-key-visualizer.md, develop/..., filter-dml-event.md, functions-and-operators/..., grafana-tikv-dashboard.md, system-variables.md
Corrects bold marker placement, spacing, punctuation, grammar, and related Japanese wording.
DM and TiCDC documentation corrections
dm/..., ticdc/...
Corrects punctuation and emphasis marker placement in DM and TiCDC documentation.
Dashboard reverse-proxy warnings
dashboard/dashboard-ops-reverse-proxy.md
Updates HAProxy and NGINX warning text about /dashboard/ path preservation and proxy scope.
TiDB Cloud documentation corrections
tidb-cloud/...
Corrects emphasis, punctuation, and wording in TiDB Cloud instructions, permissions, release notes, and filter descriptions.

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

Merge Risk: 🔵 Low · up to 1d5b4

The PR only adjusts Japanese Markdown emphasis boundaries, but three changed lines still contain localized text or punctuation defects: an extra space, a stray colon, and omitted particles. These are bounded documentation correctness issues, so the PR is mergeable with explicit owner awareness or follow-up.

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the primary change: correcting Japanese particles and punctuation trapped inside bold spans. It is concise and related to the changeset.
Description check ✅ Passed The description explains the scope, rationale, file count, special corrections, affected documentation version, AI involvement, and validation result. The blank reference-link fields are non-critical.
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.
Full details: Docstring Coverage

Explanation

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 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-bold-span-particle-boundary

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.

@yahonda
yahonda force-pushed the fix-bold-span-particle-boundary branch from 416403d to 0f09f8b Compare August 28, 2026 00:54

@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: Pro Plus

Run ID: 21c911c5-7763-4d93-a3d9-eda3f1ee005a

📥 Commits

Reviewing files that changed from the base of the PR and between a349332 and 416403d.

📒 Files selected for processing (24)
  • best-practices/pd-scheduling-best-practices.md
  • column-privilege-management.md
  • dashboard/dashboard-key-visualizer.md
  • dashboard/dashboard-ops-reverse-proxy.md
  • develop/dev-guide-create-table.md
  • develop/dev-guide-sample-application-ruby-rails.md
  • develop/dev-guide-transaction-restraints.md
  • develop/dev-guide-update-data.md
  • dm/dm-safe-mode.md
  • dm/relay-log.md
  • filter-dml-event.md
  • functions-and-operators/sequence-functions.md
  • grafana-tikv-dashboard.md
  • system-variables.md
  • ticdc/ticdc-architecture.md
  • ticdc/troubleshoot-ticdc.md
  • tidb-cloud/changefeed-sink-to-mysql.md
  • tidb-cloud/configure-external-storage-access.md
  • tidb-cloud/essential-changefeed-overview.md
  • tidb-cloud/essential-changefeed-sink-to-kafka.md
  • tidb-cloud/essential-changefeed-sink-to-mysql.md
  • tidb-cloud/integrate-tidbcloud-with-airbyte.md
  • tidb-cloud/releases/release-notes-2024.md
  • tidb-cloud/top-ru.md

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

Comment thread develop/dev-guide-create-table.md Outdated
Comment thread filter-dml-event.md Outdated
Comment thread tidb-cloud/essential-changefeed-sink-to-mysql.md Outdated
@yahonda
yahonda force-pushed the fix-bold-span-particle-boundary branch from 0f09f8b to a5335f9 Compare August 28, 2026 00:56

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

♻️ Duplicate comments (1)
develop/dev-guide-create-table.md (1)

97-97: 🎯 Functional Correctness | 🟡 Minor

Remove the remaining leading colon.

Line 97 still renders : before [日時]. The change removes bold formatting from the colon but does not remove the colon.

Committable replacement
-- :[日時](/data-type-date-and-time.md)型は、時間値を格納できます。
+- [日時](/data-type-date-and-time.md)型は、時間値を格納できます。

As per path instructions: Markdown findings must include an exact committable suggestion when the fix is contiguous.

Source: Path instructions


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: c7aa0af1-f96d-4a87-8e34-fbc98e2b367e

📥 Commits

Reviewing files that changed from the base of the PR and between 416403d and a5335f9.

📒 Files selected for processing (3)
  • best-practices/pd-scheduling-best-practices.md
  • dashboard/dashboard-ops-reverse-proxy.md
  • develop/dev-guide-create-table.md

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

@yahonda
yahonda force-pushed the fix-bold-span-particle-boundary branch from a5335f9 to 154c7f9 Compare August 28, 2026 01:16
Found via a corpus-wide scan for bold spans (**...**) whose content
starts with a Japanese comma, period, or particle character (、/。/は),
where EN's own bold boundary excludes it (e.g. "This section provides
a detailed description of these key metrics on the
**TiKV-Details** dashboard" bolds only the product name, not a
preceding comma).

24 files, 27 sites. Most fixes move the leading punctuation/particle
outside the bold span, preserving content; a few sites needed a
larger fix where the bold content had been reduced to just a bare
punctuation mark with the actual emphasized word missing or
misplaced nearby (e.g. a duplicated closing period, or three
separately-bolded numbers collapsed into one bold span with the
commas trapped inside) — each was reconstructed to match the
corresponding EN sentence's own bold boundaries exactly.

Also fixes, found while reviewing the already-touched files:
- a dropped を particle in best-practices/pd-scheduling-best-practices.md:
  `evict-slow-store-scheduler`有効にする → を有効にする.
- the mirror defect (a trailing が particle trapped INSIDE the
  closing ** instead of outside) at all 3 occurrences of an identical
  sentence in dashboard/dashboard-ops-reverse-proxy.md, matching EN's
  own bold boundary ("only in this path" is bolded, not the subject
  "services").
- a dropped は particle in develop/dev-guide-create-table.md, twice:
  once after `_tidb_rowid`, and once after a [primary key constraint]
  link, where the missing は made the sentence read as if "constraint"
  were duplicated instead of distinguishing the constraint (subject)
  from the constrained columns (object).
@yahonda
yahonda force-pushed the fix-bold-span-particle-boundary branch from 154c7f9 to 1d5b489 Compare August 28, 2026 01:16
- develop/dev-guide-create-table.md: remove a stray leading colon
  before the datetime link, inconsistent with the bullet's own
  established phrasing.
- filter-dml-event.md: restore missing が and に particles.
- tidb-cloud/essential-changefeed-sink-to-mysql.md: remove an extra
  space after a comma.
yahonda added a commit that referenced this pull request Aug 28, 2026
Found on independent review: "1番目の" before the [A Critique of
ANSI SQL Isolation Levels] link has no counterpart in EN ("According
to the standard described in the [...] paper"), the same defect
class fixed corpus-wide in #23640/#23641.
@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 28, 2026
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/M Denotes a PR that changes 30-99 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