Skip to content

Commit 468cdca

Browse files
committed
Update documentation
1 parent 76c9567 commit 468cdca

File tree

6 files changed

+33
-18
lines changed

6 files changed

+33
-18
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,25 @@
22

33
## development
44

5+
6+
## v0.6.4
7+
- Update documentation
8+
9+
510
## v0.6.3
611
- Remove ci/ directory from .gitignore again
712

13+
814
## v0.6.2
915
- Fix CircleCI recipe
1016

17+
1118
## v0.6.1
1219
- Update yarn.lock
1320
- Update documentation
1421
- Add Grafana 6.4.4 to CircleCI recipe
1522

23+
1624
## v0.6.0
1725
- Ignore "ci/" subfolder
1826
- Use "canary" variant of @grafana/toolkit. Thanks @dprokop!

CONTRIBUTING.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
1-
# Building the Grafana Map Panel
1+
# Hacking on the Grafana Map Panel
22

3+
## Introduction
34
The easiest way to get started is to git clone the project repository
45
directly into the `data/plugins` of your Grafana instance followed
56
by building it there.
67

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
139
Grafana, you will have to build the plugin once. However, you do not
1410
need to restart your local Grafana server after every change, just
1511
refreshing the page will be sufficient.
1612

17-
For packaging this plugin, invoke::
13+
## General
14+
1. Display all tasks from `grafana-toolkit`: `npx grafana-toolkit --help`
1815

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`
2021

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.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 Grafana
3+
Copyright (c) 2016-2019 Grafana Labs
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Grafana Map Panel
1+
# Grafana Map Panel %VERSION%
22

33
The Grafana Map Panel is a tile map of the world that can be overlaid with circles representing data points from a query. It can be used with time series metrics, with geohash data from Elasticsearch or data in the Table format.
44

@@ -279,4 +279,4 @@ The threshold field also accepts 2 or more comma-separated values. For example,
279279

280280
### CHANGELOG
281281

282-
The latest changes can be found here: [CHANGELOG.md](https://github.com/grafana/worldmap-panel/blob/master/CHANGELOG.md)
282+
The latest changes can be found here: [CHANGELOG.md](https://github.com/panodata/grafana-map-panel/blob/master/CHANGELOG.md)

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "grafana-map-panel",
3-
"version": "0.6.1",
4-
"description": "Grafana Map Panel",
3+
"version": "0.6.4",
4+
"description": "Map Panel",
55
"scripts": {
66
"build": "grafana-toolkit plugin:build",
77
"test": "grafana-toolkit plugin:test",

src/plugin.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@
99
"name": "Grafana Labs",
1010
"url": "https://grafana.com"
1111
},
12-
"keywords": ["worldmap", "panel"],
12+
"keywords": ["map", "panel", "worldmap"],
1313
"logos": {
1414
"small": "images/worldmap_logo.svg",
1515
"large": "images/worldmap_logo.svg"
1616
},
1717
"links": [
18-
{"name": "Project site", "url": "https://github.com/panodata/grafana-worldmap-panel"},
19-
{"name": "MIT License", "url": "https://github.com/panodata/grafana-worldmap-panel/blob/master/LICENSE"}
18+
{"name": "Project site", "url": "https://github.com/panodata/grafana-map-panel"},
19+
{"name": "MIT License", "url": "https://github.com/panodata/grafana-map-panel/blob/master/LICENSE"}
2020
],
2121
"screenshots": [
2222
{"name": "World", "path": "images/worldmap-world.png"},

0 commit comments

Comments
 (0)