Skip to content

i18n(ja): fix stray text fragments and scrambled link lists - #23640

Merged
qiancai merged 1 commit into
i18n-ja-release-8.5from
fix-stray-link-fragments
Aug 28, 2026
Merged

i18n(ja): fix stray text fragments and scrambled link lists#23640
qiancai merged 1 commit into
i18n-ja-release-8.5from
fix-stray-link-fragments

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 a recurring MT-pipeline defect: a short text fragment duplicated or misplaced immediately before a markdown link, with no counterpart in the English source (the same defect class as the stray "オプティマ" fragment fixed in #23630 and the stray "SI" fragments fixed in #23639).

  • control-execution-plan.md: removes a stray SQL duplicated before the [SQLプラン管理] link (EN: "In SQL Plan Management", no bare "SQL" before it), and restores a missing opening backtick around `tidb_opt_fix_control` in the frontmatter summary.
  • 6 sample-application "Next steps" guides (nodejs-typeorm, nodejs-prisma, nodejs-mysql2, nodejs-mysqljs, ruby-rails, ruby-mysql2) shared an identical scrambled chapter-list sentence: missing commas between several links, a stray SQL fragment before the [トランザクション] (Transactions) link, and (in 2 of the 6 files) the [クエリデータ] (Query data) link displaced to the wrong position or splitting a verb in half. Reconstructed all 6 to a single corrected sentence matching the English source's list order and structure (Insert data, Update data, Delete data, Query data, Transactions, SQL performance optimization).

7 files, 7 sites.

Method

Scanned the whole corpus for two shapes: (1) a JA text run immediately abutting a link where the run is a proper prefix of the link's own text, and (2) a short (2-5 char) token set off by a space immediately before a link. Most candidates from both scans were legitimate (e.g. TiFlash [use TiFlash], PD [config item], IETF [RFC title] — a real qualifying word genuinely preceding the link) and were left untouched; only sites verified against the exact EN sentence to have no counterpart for the leading fragment were fixed.

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 Markdown link formatting and punctuation in Japanese developer guides.
    • Improved the ordering and separation of links for data operations, transactions, queries, and SQL performance optimization.
    • Fixed wording and frontmatter formatting in the control execution plan documentation.

Found via a corpus-wide scan for a recurring MT-pipeline defect: a
short text fragment duplicated or misplaced immediately before a
markdown link, with no counterpart in the English source.

- control-execution-plan.md: removes a stray "SQL " duplicated
  before the "SQL Plan Management" link, and restores a missing
  opening backtick around `tidb_opt_fix_control` in the frontmatter
  summary.
- 6 sample-application "Next steps" guides (nodejs-typeorm,
  nodejs-prisma, nodejs-mysql2, nodejs-mysqljs, ruby-rails,
  ruby-mysql2) shared an identical scrambled chapter-list sentence:
  missing commas between several links, a stray "SQL" fragment before
  the "Transactions" link, and (in 2 of the 6 files) the "Query data"
  link displaced to the wrong position or splitting a verb in half.
  Reconstructed all 6 to a single corrected sentence matching the
  English source's list order and structure.
@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 hfxsd 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/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Aug 28, 2026
@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown

Review Change Stack

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: ff4cded3-58f6-4d53-8930-4c2e97269a4e

📥 Commits

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

📒 Files selected for processing (7)
  • control-execution-plan.md
  • develop/dev-guide-sample-application-nodejs-mysql2.md
  • develop/dev-guide-sample-application-nodejs-mysqljs.md
  • develop/dev-guide-sample-application-nodejs-prisma.md
  • develop/dev-guide-sample-application-nodejs-typeorm.md
  • develop/dev-guide-sample-application-ruby-mysql2.md
  • develop/dev-guide-sample-application-ruby-rails.md

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


📝 Walkthrough

Walkthrough

Documentation-only changes correct inline code formatting and Japanese developer-guide links across the control execution plan and sample application guides.

Changes

Documentation corrections

Layer / File(s) Summary
Reference formatting
control-execution-plan.md
The frontmatter now closes the tidb_opt_fix_control code span correctly. The SQL plan management bullet removes redundant text before its link.
Developer guide link lists
develop/dev-guide-sample-application-nodejs-*.md, develop/dev-guide-sample-application-ruby-*.md
The Japanese next-step lists now use separated links, corrected ordering, punctuation, and complete chapter labels.

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

Merge Risk: ⚪ Minimal · up to aa12b

This PR makes localized Japanese documentation corrections without changing product behavior, and no actionable merge-blocking risk remains beyond normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the Japanese localization fixes: stray text fragments and scrambled link lists.
Description check ✅ Passed The description explains the affected files, defect patterns, corrections, validation method, applicable Japanese TiDB version, and AI involvement. It is complete enough for review.
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. (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
  • Commit unit tests in branch fix-stray-link-fragments

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 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
@qiancai
qiancai merged commit 895e321 into i18n-ja-release-8.5 Aug 28, 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 Aug 28, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 28, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-08-28 08:22:04.03227808 +0000 UTC m=+835559.203372194: ☑️ agreed by qiancai.

@qiancai
qiancai deleted the fix-stray-link-fragments branch August 28, 2026 08:22
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. 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