Skip to content

i18n(ja): fix scrambled sentence and mistranslated Key Visualizer link - #23627

Merged
qiancai merged 2 commits into
i18n-ja-release-8.5from
fix-performance-tuning-overview-scramble
Aug 28, 2026
Merged

i18n(ja): fix scrambled sentence and mistranslated Key Visualizer link#23627
qiancai merged 2 commits into
i18n-ja-release-8.5from
fix-performance-tuning-overview-scramble

Conversation

@yahonda

@yahonda yahonda commented Aug 27, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Found while reviewing PR #23626: performance-tuning-overview.md's paragraph describing performance-measurement dimensions had its links scrambled across two EN sentences. EN structure:

  1. "TiDB measures and stores performance data thoroughly in different dimensions, such as [slow query logs], [Top SQL], [Continuous Performance Profiling], and [traffic visualizer]."
  2. "In addition, you can perform historical backtracking and comparison of the timing metrics data stored in Prometheus." (no links)

The JA translation only kept 2 of the 4 dimension links in the first sentence, and stuffed the other 2 (Top SQL, and a mistranslated "Key Visualizer" link rendered as 交通ビジュアライザー) into the second (link-free) sentence, making it ungrammatical.

Reconstructed to match EN's actual two-sentence structure with all 4 links in the first sentence, and fixed the Key Visualizer link text — it was rendered as 交通ビジュアライザー, a literal translation of "traffic visualizer", the generic phrase this one EN sentence used instead of the established "Key Visualizer" proper noun that's kept in English everywhere else in the corpus (a separate EN-side fix for that inconsistency is being filed against master).

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)?

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 performance baseline guidance to identify supported TiDB performance data sources.
    • Clarified coverage for slow query logs, Top SQL, continuous profiling, Key Visualizer, and historical Prometheus metrics.

Found while reviewing PR #23626 (dropped は particle sweep): the
paragraph's two EN sentences had their 4 links shuffled together —
2 of the 4 dimension links (Top SQL, Key Visualizer) had been stuffed
into the second (link-free in EN) sentence about historical
backtracking, making it ungrammatical. Reconstructed to match EN's
actual two-sentence structure and fixed the Key Visualizer link text
(was mistranslated as 交通ビジュアライザー, matching an EN-side
"traffic visualizer" inconsistency being fixed separately upstream).
@ti-chi-bot

ti-chi-bot Bot commented Aug 27, 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 qiancai 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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 27, 2026
@coderabbitai

coderabbitai Bot commented Aug 27, 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: 6f631d09-b1c5-4445-983b-7ebf57e6d5f0

📥 Commits

Reviewing files that changed from the base of the PR and between 29fffbc and f10d1ab.

📒 Files selected for processing (1)
  • performance-tuning-overview.md

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


📝 Walkthrough

Walkthrough

パフォーマンスチューニング概要で、パフォーマンスデータの参照先とPrometheus履歴メトリクスとの比較方法を明示した。

Changes

パフォーマンスデータ参照先

Layer / File(s) Summary
データ参照先の記述更新
performance-tuning-overview.md
スロークエリログ、Top SQL、継続的なパフォーマンスプロファイリング、Key Visualizer、Prometheus履歴メトリクスの参照方法を整理した。

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

Merge Risk: ⚪ Minimal · up to f10d1

This is a localized Japanese documentation correction with no actionable merge-blocking risk remaining beyond normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title clearly describes the main changes: fixing the Japanese translation and correcting the Key Visualizer link text.
Description check ✅ Passed The description covers the required change summary, affected TiDB version, related reference, AI involvement, and change-type checklist. The blank translated-from field is non-critical.
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-performance-tuning-overview-scramble

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


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 114bf683-db8d-4d18-b5d6-bb0dbed0115a

📥 Commits

Reviewing files that changed from the base of the PR and between d41688a and 29fffbc.

📒 Files selected for processing (1)
  • performance-tuning-overview.md

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

Comment thread performance-tuning-overview.md Outdated
yahonda added a commit that referenced this pull request Aug 27, 2026
- hybrid-deployment-topology.md: CodeRabbit correctly flagged that the
  added は alone didn't fix the remaining broken grammar around
  deploy_dir/なります; applied a fuller rewrite, verified against EN.
- ticdc/ticdc-compatibility.md: fixed the が-drop CodeRabbit found
  (`data-dir`が正しく構成されている), plus a second を-drop noticed
  in the same table cell while there (`data-dir`を`cdc server`...).
- performance-tuning-overview.md: reverted this PR's は-only patch --
  the whole scrambled sentence containing it is already fixed more
  completely in #23627, so this PR no longer needs to touch the file.
Prometheus stores data as time series; "タイミングメトリクス" (a
literal rendering of "timing metrics") could be misread as
latency/duration metrics specifically, rather than the general
historical metrics data being described.
@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
@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:17:40.499186206 +0000 UTC m=+835295.670280334: ☑️ agreed by qiancai.

@qiancai
qiancai merged commit 616101b into i18n-ja-release-8.5 Aug 28, 2026
5 of 9 checks passed
@qiancai
qiancai deleted the fix-performance-tuning-overview-scramble branch August 28, 2026 08:19
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/XS Denotes a PR that changes 0-9 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