github/lodestar
1
1
Fork 0
mirror of https://github.com/ChainSafe/lodestar.git synced 2026-01-10 08:08:16 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: update instructions on how to contribute to dashboards (#5581)

Browse Source 
* Update instructions on how to contribute to dashboards

* Dashboard must be saved before downloading
This commit is contained in:
Nico Flaig
2023-05-30 16:26:01 +02:00
committed by GitHub
parent abc4b1ad54
commit 083375777a
1 changed files with 19 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@@ -189,10 +189,26 @@ 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)
3. Do edits on 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. Click the "share dashboard" icon next to the title at the top left corner. Go to the "Export" tab, set "Export for sharing externally" to true and click "Save to file"
6. Paste the contents of the downloaded file in the Github repo, commit and open your PR
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
### Using Download Script
Create a file `.secrets.env` with envs
```sh
GRAFANA_API_KEY=$token
GRAFANA_URL=https://yourgrafanaapi.io
```
Run script to download dashboards to `./dashboards` folder
```sh
node scripts/download_dashboards.mjs
```
## Label Guide