Error Report
- What is the URL/path of the document related to this issue?
- How would you like to improve it?
Found several places where docs prose names a Grafana dashboard or panel with a casing/spelling that doesn't match the actual panel "title" in the dashboard JSON (pingcap/monitoring), which would make it hard for a reader to find the panel by the name given in the docs:
- The TiKV monitoring dashboard's real title is
TiKV-Details (hyphenated, both words capitalized — confirmed via the dashboard JSON's own title field, e.g. Test-Cluster-TiKV-Details). A few places spell it differently:
tikv-configuration-file.md (max-background-gc config item): "TiKV Details" (space instead of hyphen)troubleshoot-cpu-issues.md: "TiKV-details" (lowercase "d"), 2 occurrences
best-practices/massive-regions-best-practices.md says the panel is "Thread-CPU" (hyphenated), but the real panel title in tikv_details.json is "Thread CPU" (space, no hyphen).alert-rules.md (the section starting "For versions earlier than v3.0...") says "Raft propose" (lowercase "propose"), but the real panel title in tikv_details.json is "Raft Propose" (capitalized). A sibling section earlier in the same file already correctly says "Raft Propose".grafana-performance-overview-dashboard.md lists a panel bullet as "Execution Duration", but the real panel title in performance_overview.json is "Execute Duration" — matching the section's own heading ("Parse Duration, Compile Duration, and Execute Duration") just above it.
Could someone fix these 5 sites to use the exact real panel/dashboard titles? Happy to provide the exact old/new strings if useful.
(Found while reviewing the Japanese translation of these pages — the JA translations have already been corrected to match the real panel names, ahead of these EN fixes.)
Error Report
tikv-configuration-file.md)troubleshoot-cpu-issues.md)alert-rules.md)best-practices/massive-regions-best-practices.md)grafana-performance-overview-dashboard.md)Found several places where docs prose names a Grafana dashboard or panel with a casing/spelling that doesn't match the actual panel
"title"in the dashboard JSON (pingcap/monitoring), which would make it hard for a reader to find the panel by the name given in the docs:TiKV-Details(hyphenated, both words capitalized — confirmed via the dashboard JSON's owntitlefield, e.g.Test-Cluster-TiKV-Details). A few places spell it differently:tikv-configuration-file.md(max-background-gcconfig item): "TiKV Details" (space instead of hyphen)troubleshoot-cpu-issues.md: "TiKV-details" (lowercase "d"), 2 occurrencesbest-practices/massive-regions-best-practices.mdsays the panel is "Thread-CPU" (hyphenated), but the real panel title intikv_details.jsonis"Thread CPU"(space, no hyphen).alert-rules.md(the section starting "For versions earlier than v3.0...") says "Raft propose" (lowercase "propose"), but the real panel title intikv_details.jsonis"Raft Propose"(capitalized). A sibling section earlier in the same file already correctly says "Raft Propose".grafana-performance-overview-dashboard.mdlists a panel bullet as "Execution Duration", but the real panel title inperformance_overview.jsonis"Execute Duration"— matching the section's own heading ("Parse Duration, Compile Duration, and Execute Duration") just above it.Could someone fix these 5 sites to use the exact real panel/dashboard titles? Happy to provide the exact old/new strings if useful.
(Found while reviewing the Japanese translation of these pages — the JA translations have already been corrected to match the real panel names, ahead of these EN fixes.)