From 8a85053453a32e263eaf8e9e540c6e39eb85d1b1 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Fri, 4 Oct 2024 15:24:17 +0200 Subject: [PATCH] docs: update notes on how to upgrade grafonnet --- docs/contributing.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 6fd7c4c..cb67c14 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -57,9 +57,15 @@ with `jsonnet`, you can deploy dashboards to a Grafana instance like this: ### Upgrading the grafonnet version -The grafonnet jsonnet library is bundled here with [jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler). -Just running `jb update` in the git repo root dir after installing jsonnet-bunder should bring -you up to speed. +The grafonnet jsonnet library is bundled here with [jsonnet-bundler]. The +upgrade procedure looks looks like this: + +1. Install jsonnet-bunder +2. Update `jsonnetfile.json` to reference the new version +3. Run `jb update` in the git repo root dir +4. Search and replace remaining old version references with the new version + +[jsonnet-bundler]: https://github.com/jsonnet-bundler/jsonnet-bundler ### Metrics guidelines