pingcap / pingcap/docs

Several docs pages misname Grafana panel/dashboard titles (casing/spelling mismatches)

Open Beginner friendly
#23,818 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

Error Report

  1. What is the URL/path of the document related to this issue?
  1. 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.)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
grafana
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.