Skip to content

i18n(ja): restore literal English Grafana panel names in TiKV dashboard doc - #23781

Closed
yahonda wants to merge 7 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-grafana-tikv-dashboard-english
Closed

i18n(ja): restore literal English Grafana panel names in TiKV dashboard doc#23781
yahonda wants to merge 7 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-grafana-tikv-dashboard-english

Conversation

@yahonda

@yahonda yahonda commented Sep 9, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

grafana-tikv-dashboard.md documents the literal panel/metric names shown on the actual TiKV Grafana dashboard (both TiKV-Details and TiKV-FastTune sub-dashboards). Nearly every section heading and metric bullet label had been machine-translated into Japanese, breaking the reader's ability to match a label against what they see in the live Grafana UI -- the same defect class already fixed in the sibling grafana-*-dashboard.md files via pingcap/docs#23763 and pingcap/docs#23774.

Restored all panel/row/metric labels to literal English (matching the live Grafana UI) while keeping each bullet's Japanese description text unchanged. Also fixed one unrelated particle-trapped-in-bold defect found in passing (line 604: **TiKV-FastTuneの**ダッシュボードには**TiKV-FastTune**のダッシュボードには).

Every heading was individually verified against upstream/release-8.5 to match exactly (anchors unchanged).

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 the TiKV-Details dashboard documentation to use English metric names matching the Grafana dashboard.
    • Retained Japanese explanatory descriptions for the documented metrics.
    • Corrected formatting so the full “TiKV-FastTune” product name appears in bold.

…rd doc

grafana-tikv-dashboard.md documents the literal panel/metric names shown
on the actual TiKV Grafana dashboard. Restored panel/row/metric labels to
literal English (matching the live Grafana UI) while keeping the Japanese
description text after each label unchanged, matching the same defect
class already fixed in the sibling grafana-*-dashboard.md files via PR
pingcap#23763 and PR pingcap#23774.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@ti-chi-bot

ti-chi-bot Bot commented Sep 9, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 9, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 9, 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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Sep 9, 2026
@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

📝 Walkthrough

Walkthrough

The TiKV-Details dashboard documentation now uses English metric names from Grafana. Japanese descriptions and images remain unchanged. The document also corrects bold formatting for “TiKV-FastTune”.

Changes

Dashboard documentation

Layer / File(s) Summary
Dashboard labels and formatting
grafana-tikv-dashboard.md
TiKV-Details headings and metric list items now use Grafana’s English names. Japanese explanations and images remain unchanged. The full “TiKV-FastTune” product name is bolded.

Priority: ⬇️ Low

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

Merge Risk: 🔵 Low · up to dbac4

The dashboard documentation mostly restores Grafana labels, but two Store size entries do not exactly match the dashboard’s lowercase store size label, which can impede direct panel matching. Correcting the casing resolves the remaining bounded documentation issue.

🚥 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.
Description check ✅ Passed The description clearly explains the documentation changes, affected version, reference PRs, AI involvement, and unchanged checklist items. It provides sufficient context for review.
Title check ✅ Passed The title clearly identifies the Japanese localization change and the restoration of literal English Grafana panel names, which is the main purpose of the 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.

yahonda and others added 4 commits September 9, 2026 09:21
…tion wording

grafana-tikv-dashboard.md's Raft process section (Ready handled and
neighboring bullets) mistranslated the Raft library's 'ready' concept
(the well-known etcd/raft Ready struct/state, not a generic English
adjective) as 準備完了 ("preparation complete"). Confirmed via docs-cn,
which keeps 'ready' as a literal untranslated term throughout the
identical section. Restored 'ready'/'Ready' as a literal term (matching
each site's own casing convention: Title Case only in the panel label
itself, lowercase in body-text prose, matching both EN's and docs-cn's
own casing).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
grafana-tikv-dashboard.md: 'Admin proposals' (a Raft admin-type proposal
category, per the Raft admin section and confirmed literal in docs-cn)
was translated as 管理者提案数 (an administrator/person's proposal count)
instead of 管理提案数 (administrative proposal count).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…d doc

Full 1:1 review against upstream/release-8.5 (and docs-cn for
tie-breaking ambiguous technical terms) found several description-level
mistranslations beyond the earlier label-only pass:

- Active written leaders: 執筆 (literary 'written') was a false friend
  for the data-write sense of 'written' -> reworded to 書き込みが行われている.
- Store writer CPU: word-order scramble dropped the '90% * config-name'
  multiplicative threshold structure -> restored to match sibling CPU bullets.
- Blob (Titan's storage-engine term): unified 4 inconsistent renderings
  (Blob/ブロブ/BLOB/blob) to the dominant literal 'Blob', matching the
  Region/Ready/Admin literal-jargon convention already established in
  this file.
- Max gap of resolved-ts / safe-ts: 領域 (generic 'area') was a false
  friend for Region -> restored to リージョン, matching the identical
  phrase 3 lines later in the same file; also restored literal safe-ts
  instead of a translated 安全時刻 gloss, matching resolved-ts's own
  literal treatment.
- Observed Region Count: 視聴 (TV/broadcast 'watching') was a false
  friend for the event-listener sense of 'listened to' -> reworded to
  監視されている, matching the file's own correct リスナー/リスニング
  renderings for the same underlying concept elsewhere.
- A zero-width-space artifact (U+200B x2) removed from Request duration.
- Total DAG Executors: 実行者 (a human agent) was a false friend for the
  DAG Executor software component -> kept literal.
- Total Ops Details by CF (Table Scan): 選択スキャン unified to selectスキャン,
  matching the sibling Table Scan bullet's own literal select rendering.
- Compaction operations/duration: 洗浄 ('washing') was a false friend for
  the RocksDB 'flush' operation -> reworded to フラッシュ.
- Write stall duration: fixed a scrambled imperative-verb reading
  ('write down the stop time') back to the intended noun phrase.
- Keys flow: fixed a modifier-attachment scramble ('per type' had
  attached to 'keys' instead of 'operations'), matching the parallel
  Read flow/Write flow bullets' own structure.
- Oldest snapshots duration: 未公開 (undisclosed/unpublished) was a false
  friend for the resource-management sense of 'unreleased' -> reworded
  to 未解放.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
- Waiter lifetime duration: fixed inverted agent -- the JA said the
  waiting transaction releases the lock, when EN/docs-cn say the
  transaction waits for the (other holder's) lock to be released.
- Min Safe TS Region: restored literal safe-ts (was half-translated as
  安全TS), matching the sibling resolved-ts line's literal treatment.
- Allocator Stats: メモリ割り当て (allocation, the action) was a false
  friend for メモリアロケータ (allocator, the component).
- Initial Scan Generate Event Throughput: 段階的 (phased) was the sole
  outlier for 'incremental' in this Log Backup section, where every
  other occurrence correctly uses 増分.
- A body-prose mention of the TiKV-Details dashboard's own name was
  translated as TiKVの詳細instead of kept literal, matching this doc's
  own H2 heading and the parallel TiKV-FastTune treatment.
- Blob prev duration: translated 'prev' to 前の, matching the sibling
  Blob next duration bullet's own already-translated 次の (they had
  disagreed with each other, one literal one translated).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@yahonda
yahonda force-pushed the fix-grafana-tikv-dashboard-english branch from 0293481 to 8922033 Compare September 9, 2026 00:33
docs-cn keeps 'apply' as a literal untranslated term throughout this
same Raft/TiKV-internal jargon context (Apply log duration, Raft apply
proposals, Apply wait duration, Admin apply, apply-to-memory, Apply
Request Throughput/Batch Size/Speed), consistent with the already-fixed
ready/Admin/Blob literal-jargon convention in this file. Unified all 10
sites from 適用 to a literal apply/applyする form.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@yahonda
yahonda marked this pull request as ready for review September 9, 2026 00:38
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 9, 2026

@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: 081b7654-d509-4d23-9891-4fae9b90692f

📥 Commits

Reviewing files that changed from the base of the PR and between a2da298 and dbac4e2.

📒 Files selected for processing (1)
  • grafana-tikv-dashboard.md

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

Comment thread grafana-tikv-dashboard.md
Reverting the earlier decision to keep Raft's 'ready'/'apply' jargon
as literal English in body-text descriptions. Restored to the original
Japanese translations (readyやapply were literal-English attempts to
match docs-cn's own treatment, but on review the mixed-register result
read worse in context, e.g. a 3-item parallel list becoming
'提案/コミット/Apply'). Reverted back to 準備完了/適用 throughout.
Panel/metric LABELS that were already correctly English before this
whole campaign (Ready handled, Process ready duration, Apply Log
Duration, Admin apply, etc.) are unaffected -- this only reverts the
DESCRIPTION-text word choice.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
yahonda added a commit to yahonda/docs that referenced this pull request Sep 9, 2026
Reverting the earlier decision to keep Raft's 'apply' jargon as literal
English in body-text descriptions (policy reversal, see pingcap#23781's
latest commit for the full rationale). Restored to 適用 in the
description text of dashboard/dashboard-monitoring.md and
grafana-performance-overview-dashboard.md. Panel/metric LABELS (Apply
Duration, Apply Log Duration headings) are unaffected -- those are the
literal EN panel names, not the reverted word choice.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@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 10, 2026
@yahonda

yahonda commented Sep 10, 2026

Copy link
Copy Markdown
Member Author

Superseded by #23816, which includes a complete, JSON-verified fix for the same grafana-tikv-dashboard.md literal-panel-name issue (and more). Closing this PR.

@yahonda yahonda closed this Sep 10, 2026
yahonda added a commit to yahonda/docs that referenced this pull request Sep 10, 2026
Reverting the earlier decision to keep Raft's 'apply' jargon as literal
English in body-text descriptions (policy reversal, see pingcap#23781's
latest commit for the full rationale). Restored to 適用 in the
description text of dashboard/dashboard-monitoring.md and
grafana-performance-overview-dashboard.md. Panel/metric LABELS (Apply
Duration, Apply Log Duration headings) are unaffected -- those are the
literal EN panel names, not the reverted word choice.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XXL Denotes a PR that changes 1000+ 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