Skip to content

Commit

Permalink
docs: update instructions on how to contribute to dashboards (#5832)
Browse files Browse the repository at this point in the history
* docs: update instructions on how to contribute to dashboards

* Add UID to spell check word list
  • Loading branch information
nflaig authored Aug 1, 2023
1 parent 67b6e79 commit 7438c26
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ TOC
TTD
TypeScript
UI
UID
UTF
VM
Vitalik
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,10 +195,10 @@ Contributors must choose the log level carefully to ensure a consistent experien
To edit or extend an existing Grafana dashboard with minimal diff:

1. Grab the `.json` dashboard file from current unstable
2. Import file to Grafana via the web UI at `/dashboard/import`. Give it some temporal name relevant to your work (i.e. the branch name)
2. Import the file to Grafana via the web UI at `/dashboard/import` without modifying the UID of the dashboard
3. Visually edit the dashboard
4. Once done make sure to leave the exact same visual aspect as before: same refresh interval, collapsed rows, etc.
5. Save the dashboard (CTRL + S)
4. Once done make sure to leave the exact same visual aspect as before: same refresh interval, time range, etc.
5. Save the dashboard (CTRL+S)
6. Run download script, see [below](#using-download-script) on how to use it
7. Check git diff of updated dashboards, commit, push and open your PR

Expand Down

0 comments on commit 7438c26

Please sign in to comment.