|
1 |
| -# Building the Grafana Map Panel |
| 1 | +# Hacking on the Grafana Map Panel |
2 | 2 |
|
| 3 | +## Introduction |
3 | 4 | The easiest way to get started is to git clone the project repository
|
4 | 5 | directly into the `data/plugins` of your Grafana instance followed
|
5 | 6 | by building it there.
|
6 | 7 |
|
7 |
| -1. Install npm packages: `npx yarn install` |
8 |
| -2. Build and lint the JavaScript: `npx yarn build` |
9 |
| -2. Run the tests before submitting a PR: `npx yarn test` |
10 |
| -3. A test watcher when TDD:ing: `npx yarn dev --watch` |
11 |
| - |
12 |
| -Grafana will read in the `dist` folder first so to see your changes in |
| 8 | +Grafana will read in the `dist` folder first. So, to see your changes in |
13 | 9 | Grafana, you will have to build the plugin once. However, you do not
|
14 | 10 | need to restart your local Grafana server after every change, just
|
15 | 11 | refreshing the page will be sufficient.
|
16 | 12 |
|
17 |
| -For packaging this plugin, invoke:: |
| 13 | +## General |
| 14 | +1. Display all tasks from `grafana-toolkit`: `npx grafana-toolkit --help` |
18 | 15 |
|
19 |
| - npx grafana-toolkit plugin:ci-package |
| 16 | +## Development |
| 17 | +1. Install packages: `npx yarn install` |
| 18 | +2. Bundle plugin in dev mode: `npx yarn dev` |
| 19 | +3. Bundle plugin in dev mode and start a watcher: `npx yarn watch` |
| 20 | +4. Run the tests before submitting a PR: `npx yarn test` |
20 | 21 |
|
21 |
| -When this process succeeds, packages can be found within the `ci/packages/` folder. |
| 22 | + |
| 23 | +# Building the Grafana Map Panel |
| 24 | +1. Install packages: `npx yarn install` |
| 25 | +2. Build into `dist/`, lint and run tests: `npx yarn build` |
| 26 | +3. Build plugin on CI: `npx grafana-toolkit plugin:ci-build` |
| 27 | +4. Create a zip package: `npx grafana-toolkit plugin:ci-package` |
| 28 | + When this process succeeds, packages can be found within the `ci/packages/` folder. |
0 commit comments