i18n(ja): restore literal English Grafana panel names in TiKV dashboard doc - #23781
i18n(ja): restore literal English Grafana panel names in TiKV dashboard doc#23781yahonda wants to merge 7 commits into
Conversation
…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>
|
Skipping CI for Draft Pull Request. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
📝 WalkthroughWalkthroughThe 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”. ChangesDashboard documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: 🔵 Low · up to The dashboard documentation mostly restores Grafana labels, but two 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
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. Comment |
…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>
0293481 to
8922033
Compare
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>
There was a problem hiding this comment.
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
📒 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.
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>
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>
|
Superseded by #23816, which includes a complete, JSON-verified fix for the same |
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>
What is changed, added or deleted? (Required)
grafana-tikv-dashboard.mddocuments 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 siblinggrafana-*-dashboard.mdfiles 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.5to match exactly (anchors unchanged).Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit