Skip to content

Commit 1aa9e82

Browse files
committed
Improve documentation
1 parent 9ea3bd9 commit 1aa9e82

File tree

3 files changed

+20
-1
lines changed

3 files changed

+20
-1
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,8 @@ coverage/
1010
artifacts/
1111

1212
.venv*
13+
.nenv*
1314
build/
1415
ci/
16+
17+
*.old

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,21 @@ Grafana, you will have to build the plugin once. However, you do not
1010
need to restart your local Grafana server after every change, just
1111
refreshing the page will be sufficient.
1212

13+
## Sandbox setup
14+
The easiest way to invoke a development sandbox is by using Docker.
15+
```shell
16+
# Run with Grafana 7
17+
docker run --publish=3000:3000 --volume=$PWD/dist:/var/lib/grafana/plugins/grafana-map-panel grafana/grafana:7.5.7
18+
```
19+
20+
Because the version of `node-sass` used as transitive dependency is apparently
21+
not compatible with Node 16 yet, let's use Node 15:
22+
```shell
23+
brew install nodeenv
24+
nodeenv --node=15.14.0 .nenv
25+
source .nenv/bin/activate
26+
```
27+
1328
## General
1429
- Display all tasks from `grafana-toolkit`: `npx grafana-toolkit --help`
1530

src/plugin.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@
2828
},
2929

3030
"dependencies": {
31-
"grafanaVersion": "6.x.x",
31+
"grafanaVersion": ">=6.0.0",
32+
"grafanaDependency": ">=6.0.0",
3233
"plugins": [ ]
3334
}
3435
}

0 commit comments

Comments
 (0)