Skip to content

Commit ed73552

Browse files
committed
Update documentation to reflect naming
1 parent 2cdaf38 commit ed73552

File tree

3 files changed

+33
-28
lines changed

3 files changed

+33
-28
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
# Building WorldMap
1+
# Building the Grafana Map Panel
22

3-
The easiest way to get started is to git clone the WorldMap project directly into the `data/plugins` folder in the Grafana source. (A git repo inside of a git repo)
3+
The easiest way to get started is to git clone the project repository
4+
directly into the `data/plugins` of your Grafana instance followed
5+
by building it there.
46

5-
1. Install npm packages: `npm install`
6-
2. Build and lint the JavaScript: `npm run build`
7-
2. Run the tests before submitting a PR: `npm run test`
8-
3. A test watcher when TDD:ing: `npm run test:watch`
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`
911

10-
Grafana will read in the dist folder first so to see your changes to WorldMap in Grafana, you have to run Grunt. However, you do not need to restart your local Grafana server after every change; just refresh the page.
12+
Grafana will read in the `dist` folder first so to see your changes in
13+
Grafana, you will have to build the plugin once. However, you do not
14+
need to restart your local Grafana server after every change, just
15+
refreshing the page will be sufficient.

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Worldmap Panel Plugin for Grafana
1+
# Grafana Map Panel
22

3-
The Worldmap 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.
3+
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

5-
![Worldmap](https://raw.githubusercontent.com/grafana/worldmap-panel/54f83cfdc7339fee02df00933422c35630677330/src/images/worldmap-world.png)
5+
![Grafana Map](https://raw.githubusercontent.com/grafana/worldmap-panel/54f83cfdc7339fee02df00933422c35630677330/src/images/worldmap-world.png)
66

7-
## How The Worldmap Works (Theory and Examples)
7+
## How this works (theory and examples)
88

9-
The Worldmap panel needs two sources of data:
9+
This plugin needs two sources of data:
1010

1111
- a location (latitude and longitude)
1212
- data that has a link to a location
@@ -50,7 +50,7 @@ Location data should be in the JSON format and should be an array of JSON object
5050
]
5151
```
5252

53-
The Worldmap will then match the metric name (target in the example data) with a key field from the location data. With this example data there will be two circles drawn on the map, one for Sweden and one for the United States with values 183255 and 192224.
53+
The metric name (target in the example data) will be matched with a key field from the location data. With this example data there will be two circles drawn on the map, one for Sweden and one for the United States with values 183255 and 192224.
5454

5555
### Table Format
5656

@@ -79,7 +79,7 @@ Table data is tabular data with columns and rows. Here is an example of Table da
7979
]
8080
```
8181

82-
This query contains both data (the value `75.654324173059`) and a location (the geohash `9wvfgzurfzb` which is in Colorado). So using these, the Worldmap panel will draw one circle in Colorado, USA with the value 75.654324173059.
82+
This query contains both data (the value `75.654324173059`) and a location (the geohash `9wvfgzurfzb` which is in Colorado). So using these, one circle will be drawn in Colorado, USA with the value 75.654324173059.
8383

8484
## Time Series Data as the Data Source
8585

@@ -121,7 +121,7 @@ Use the aliasByNode function to point to the field containing the country code.
121121

122122
![Graphite Query for Countries](https://raw.githubusercontent.com/grafana/worldmap-panel/master/src/images/worldmap-timeseries-query.png)
123123

124-
Example dashboard for Worldmap with Graphite queries on [the Grafana play site](http://localhost:3000/d/000000003/worldmap-panels?panelId=8&fullscreen&edit&orgId=1).
124+
Example dashboard with Graphite queries on [the Grafana play site](http://localhost:3000/d/000000003/worldmap-panels?panelId=8&fullscreen&edit&orgId=1).
125125

126126
#### InfluxDB Query
127127

@@ -137,19 +137,19 @@ Use a Group By clause on the field containing the country code and a Then by cla
137137

138138
#### Map Data Options for Time Series Data
139139

140-
Under the Worldmap tab, choose either the `countries` or `states` option.
140+
On the editor tab, choose either the `countries` or `states` option.
141141

142-
![Worldmap Options for Countries](https://raw.githubusercontent.com/grafana/worldmap-panel/master/src/images/countries-option.png)
142+
![Options for Countries](https://raw.githubusercontent.com/grafana/worldmap-panel/master/src/images/countries-option.png)
143143

144144
Using a JSON endpoint to return a custom list of locations:
145145

146-
![Worldmap Options for JSON](https://raw.githubusercontent.com/grafana/worldmap-panel/master/src/images/json-endpoint.png)
146+
![Options for JSON](https://raw.githubusercontent.com/grafana/worldmap-panel/master/src/images/json-endpoint.png)
147147

148148
The endpoint used here is for the demo version of worldPing - [https://worldpingdemo.grafana.net/api/plugin-proxy/raintank-worldping-app/api/v2/probes/locations](https://worldpingdemo.grafana.net/api/plugin-proxy/raintank-worldping-app/api/v2/probes/locations). If you have your own endpoint defined it must be reachable from the client side, as it is approached by client's browser.
149149

150150
Using a JSONP endpoint (if you need to wrap the JSON to get around CORS problems):
151151

152-
![Worldmap Options for JSONP](https://raw.githubusercontent.com/grafana/worldmap-panel/master/src/images/jsonp-endpoint.png)
152+
![Options for JSONP](https://raw.githubusercontent.com/grafana/worldmap-panel/master/src/images/jsonp-endpoint.png)
153153

154154
For some details on troubleshooting JSON/JSONP check [#47](https://github.com/grafana/worldmap-panel/issues/47).
155155

@@ -159,17 +159,17 @@ Supported Databases:
159159

160160
- ElasticSearch
161161

162-
The [Geo-point](https://www.elastic.co/guide/en/elasticsearch/reference/2.3/geo-point.html) data type with geohash indexing in Elasticsearch can also be used as a datasource for the worldmap panel. Grafana has a new bucket aggregate for Elasticsearch queries - Geo Hash Grid that allows grouping of coordinates. The Geo Hash Grid has a precision option where 1 is the highest level and 7 is the lowest.
162+
The [Geo-point](https://www.elastic.co/guide/en/elasticsearch/reference/2.3/geo-point.html) data type with geohash indexing in Elasticsearch can also be used as a datasource. Grafana has a new bucket aggregate for Elasticsearch queries - Geo Hash Grid that allows grouping of coordinates. The Geo Hash Grid has a precision option where 1 is the highest level and 7 is the lowest.
163163

164-
![Elasticsearch Query for Worldmap](https://raw.githubusercontent.com/grafana/worldmap-panel/master/src/images/worldmap-geohash-query.png)
164+
![Elasticsearch Query](https://raw.githubusercontent.com/grafana/worldmap-panel/master/src/images/worldmap-geohash-query.png)
165165

166166
Three fields need to be provided by the ElasticSearch query:
167167

168168
- A metric. This is free text and should match the aggregation used (Count, Average, Sum, Unique Count etc.)
169169
- Location Name (optional - geohash value will be shown if not chosen)
170170
- geo_point field that provides the geohash value.
171171

172-
![Elasticsearch Query for Worldmap](https://raw.githubusercontent.com/grafana/worldmap-panel/master/src/images/es-options.png)
172+
![Elasticsearch Query](https://raw.githubusercontent.com/grafana/worldmap-panel/master/src/images/es-options.png)
173173

174174
## Table Data as the Data Source
175175

@@ -190,7 +190,7 @@ Similar to the Elasticsearch query above, 3 fields are expected (2 of them are m
190190
- A *geohash* field. This is used to calculate where the circle should be drawn.
191191
- an optional location name field (shown in the mouse over). Used to label each circle on the map. If it is empty then the geohash value is used as the label.
192192

193-
The field mappings have to be specified on the Worldmap settings tab.
193+
The field mappings have to be specified on the Grafana Map settings tab.
194194

195195
![Example influxdb query](https://cloud.githubusercontent.com/assets/434655/16535977/8cd520be-3fec-11e6-8dc9-2ecf7b16ad5f.png)
196196

@@ -214,7 +214,7 @@ It supports any datasource capable of generating a JSON response with a custom l
214214

215215
#### Location Data
216216

217-
There are four ways to provide data for the worldmap panel:
217+
There are four ways to provide data to this plugin:
218218

219219
- *countries*: This is a list of all the countries in the world. It works by matching a country code (US, FR, AU) to a node alias in a time series query.
220220
- *states*: Similar to countries but for the states in USA e.g. CA for California

src/partials/editor.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<span>
33

44
The
5-
<a href="https://github.com/panodata/grafana-worldmap-panel" class="editor-link-color" target="_blank">
6-
Worldmap Panel NG
5+
<a href="https://github.com/panodata/grafana-map-panel" class="editor-link-color" target="_blank">
6+
Grafana Map Panel NG
77
</a>
8-
(<a href="https://github.com/panodata/grafana-worldmap-panel/blob/develop/CHANGELOG.md" class="editor-link-color" target="_blank">changes</a>)
8+
(<a href="https://github.com/panodata/grafana-map-panel/blob/develop/CHANGELOG.md" class="editor-link-color" target="_blank">changes</a>)
99
is work in progress.
1010

1111
Enjoy
@@ -16,7 +16,7 @@
1616
<a href="https://community.grafana.com/t/giving-the-grafana-worldmap-panel-some-love/17210" class="editor-link-color" target="_blank">[1]</a>,
1717
<a href="https://github.com/grafana/worldmap-panel/issues/197" class="editor-link-color" target="_blank">[2]</a>
1818
and
19-
<a href="https://github.com/panodata/grafana-worldmap-panel" class="editor-link-color" target="_blank">[3]</a>.
19+
<a href="https://github.com/panodata/grafana-map-panel" class="editor-link-color" target="_blank">[3]</a>.
2020

2121
Please don't use this software in production yet.
2222

0 commit comments

Comments
 (0)