Skip to content

i18n(ja): fix requirement-strength inversions (should mistranslated as must) - #23731

Merged
qiancai merged 6 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-ja-should-inflated-to-must
Sep 4, 2026
Merged

i18n(ja): fix requirement-strength inversions (should mistranslated as must)#23731
qiancai merged 6 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-ja-should-inflated-to-must

Conversation

@yahonda

@yahonda yahonda commented Sep 4, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Fix 10 requirement-strength inversions across 7 files, where English "should" (an advisory recommendation) was mistranslated as Japanese する必要があります / でなければなりません (a mandatory requirement), inflating a recommendation into a hard requirement:

  • br/br-snapshot-guide.md — "should be tested in actual environments" → テストする必要があります (should be テストすることをお勧めします)
  • br/use-br-command-line-tool.md — "you should tune ... instead" → 調整する必要があります (should be 調整することをお勧めします)
  • br/br-compact-log-backup.md — "should match the output from the log status command" → 一致する必要があります (should be 一致させることを推奨します)
  • dm/dm-best-practices.md — "you should reserve some work nodes as standby nodes" → 確保する必要があります (should be 確保することをお勧めします)
  • best-practices/tidb-best-practices.md — "the number of indexes should be proper" → 適切でなければなりません (should be 適切であることが望まれます)
  • tikv-configuration-file.md (max-bytes-per-sec) — "should be set to the disk's optimal I/O bandwidth" → 設定する必要があります (should be 設定することをお勧めします)
  • tikv-configuration-file.md (max-bytes-for-level-base) — "should be write-buffer-size * 4" → にする必要があります (should be にすることをお勧めします)
  • tikv-configuration-file.md (renew-interval) — "you should also consider the load of PD" → 考慮する必要があります (should be 考慮することをお勧めします)
  • tiflash/tiflash-configuration.md (advertise-addr) — "You should guarantee that other nodes can access" → 保証する必要があります (should be 保証することをお勧めします)
  • tiflash/tiflash-configuration.md (advertise-status-addr) — same pattern as above

All verified against the English source on release-8.5 for the same file/section before fixing.

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
    • Updated Japanese documentation across backup, snapshot restore, migration, TiFlash, TiKV, and indexing guidance.
    • Reworded several mandatory-sounding statements as recommendations, clarifying that the described operational practices are advisable rather than strict requirements.
    • Configuration behavior, command options, recommended ranges, and functionality remain unchanged.

…s must)

10 sites across 7 files rendered English "should" (a recommendation) as
Japanese する必要があります / でなければなりません (a mandatory
requirement), inflating advisory guidance into a hard requirement.
Changed each to お勧めします / 推奨します / 望まれます to match the
EN source's actual modal strength.
@ti-chi-bot

ti-chi-bot Bot commented Sep 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 jackysp 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 missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 4, 2026
@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

Next included review available in 48 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 4 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 67dd79a3-65bb-49b7-a92e-97cdac4e83af

📥 Commits

Reviewing files that changed from the base of the PR and between f4c69ff and 3725bc2.

📒 Files selected for processing (6)
  • best-practices/tidb-best-practices.md
  • br/br-snapshot-guide.md
  • br/use-br-command-line-tool.md
  • dm/dm-best-practices.md
  • tiflash/tiflash-configuration.md
  • tikv-configuration-file.md

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 1767c579-0095-4c91-851c-9a1a238cadf8

📥 Commits

Reviewing files that changed from the base of the PR and between 6b1f679 and f4c69ff.

📒 Files selected for processing (7)
  • best-practices/tidb-best-practices.md
  • br/br-compact-log-backup.md
  • br/br-snapshot-guide.md
  • br/use-br-command-line-tool.md
  • dm/dm-best-practices.md
  • tiflash/tiflash-configuration.md
  • tikv-configuration-file.md

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


📝 Walkthrough

Walkthrough

Japanese documentation guidance was reworded across TiDB, BR, DM, TiFlash, and TiKV. Mandatory expressions now use recommendation wording. No code, API, configuration value, or functional behavior changed.

Changes

Recommendation wording updates

Layer / File(s) Summary
Best-practice guidance wording
best-practices/tidb-best-practices.md, dm/dm-best-practices.md
TiDB index guidance and DM standby worker guidance now use recommendation wording.
BR guidance wording
br/br-compact-log-backup.md, br/br-snapshot-guide.md, br/use-br-command-line-tool.md
BR backup and restore guidance now uses recommendation wording for storage matching, performance testing, and thread adjustment.
Configuration guidance wording
tiflash/tiflash-configuration.md, tikv-configuration-file.md
TiFlash address guidance and three TiKV configuration descriptions now use recommendation wording.

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

Merge Risk: ⚪ Minimal · up to f4c69

This change corrects Japanese documentation from mandatory to advisory wording while preserving the documented technical guidance and values. No current merge-readiness risk remains.

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: correcting Japanese translations that incorrectly express advisory “should” statements as mandatory requirements.
Description check ✅ Passed The description explains the 10 wording corrections, identifies all 7 affected files and sections, states the applicable Japanese TiDB 8.5 version, and records AI involvement. The reference-link field…
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: Description check

Explanation

The description explains the 10 wording corrections, identifies all 7 affected files and sections, states the applicable Japanese TiDB 8.5 version, and records AI involvement. The reference-link fields are blank, but the required information is otherwise complete.

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

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

望まれます read as vague/passive for technical documentation; べきです
is the more idiomatic technical-doc rendering of English "should" here.
Use the more standard technical-doc term 推奨します instead of
お勧めします for consistency across this fix's new insertions.
"保証することを推奨します" ("recommend guaranteeing") reads as
contradictory in Japanese since 保証 (absolute) and 推奨 (advisory)
clash. Rephrase as "アクセスできるようにすることを推奨します" to keep
the advisory tone consistent throughout.
Revert the previous paraphrase; translate the EN source literally
("You should guarantee that...") and express the should-tier modal
strength via 推奨されます instead of dropping the word 保証.
Switch from passive 推奨されます to active 推奨します, matching the
other should-tier fixes in this PR.
@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 4, 2026
@qiancai
qiancai merged commit 1e88904 into pingcap:i18n-ja-release-8.5 Sep 4, 2026
5 of 9 checks passed
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Sep 4, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 4, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-09-04 12:20:24.182246143 +0000 UTC m=+1454659.353340257: ☑️ agreed by qiancai.

@yahonda
yahonda deleted the fix-ja-should-inflated-to-must branch September 7, 2026 00:22
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/S Denotes a PR that changes 10-29 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