Several docs pages misname Grafana panel/dashboard titles (casing/spelling mismatches)
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- grafana
- Domain
- documentation
Research direction
Start with the five files named in the issue: tikv-configuration-file.md, troubleshoot-cpu-issues.md, alert-rules.md, best-practices/massive-regions-best-practices.md, and grafana-performance-overview-dashboard.md. Compare each cited name with the relevant dashboard JSON titles, then update the five mismatches and verify that the English pages use the exact panel or dashboard titles.
Written by the indexing model from the issue text.
Description
Error Report
- What is the URL/path of the document related to this issue?
- https://docs.pingcap.com/tidb/dev/tikv-configuration-file (
tikv-configuration-file.md) - https://docs.pingcap.com/tidb/dev/troubleshoot-high-cpu-usage (
troubleshoot-cpu-issues.md) - https://docs.pingcap.com/tidb/dev/alert-rules (
alert-rules.md) - https://docs.pingcap.com/tidb/dev/best-practices/massive-regions-best-practices (
best-practices/massive-regions-best-practices.md) - https://docs.pingcap.com/tidb/dev/grafana-performance-overview-dashboard (
grafana-performance-overview-dashboard.md)
- 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 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 occurrences
best-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.)
- Dominant language
- Python
- Stars
- 617
- Forks
- 724
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 225
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from pingcap/docs
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
Broken Link Detected Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
Broken Link Detected Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100