diff --git a/CHANGELOG.md b/CHANGELOG.md index 70e85a5..d550d4b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,12 +2,11 @@ ## development - Add compatibility with Grafana 8 - - Add Makefile to assist in packaging and publishing - Overlay image can now be refreshed with the dashboard. Thanks, @jreyesr! - Revert "Support multiple metrics in popup content for Elasticsearch" again. The feature was not ready to be used with PostgreSQL and InfluxDB datasources yet. - Thanks, @matschaffer! +- Update plugin name to "panodata-map-panel" ## v0.15.0 - Support multiple metrics in popup content for Elasticsearch. Thanks, @matschaffer! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11b9afe..053373d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Hacking on the Grafana Map Panel +# Hacking on the Panodata Map Panel ## Introduction The easiest way to get started is to git clone the project repository @@ -14,10 +14,10 @@ refreshing the page will be sufficient. The easiest way to invoke a development sandbox is by using Docker. ```shell # Run with Grafana 7 -docker run --publish=3000:3000 --volume=$PWD/dist:/var/lib/grafana/plugins/grafana-map-panel grafana/grafana:7.5.7 +docker run --publish=3000:3000 --volume=$PWD/dist:/var/lib/grafana/plugins/panodata-map-panel grafana/grafana:7.5.10 # Run with Grafana 8 -docker run --publish=3000:3000 --volume=$PWD/dist:/var/lib/grafana/plugins/grafana-map-panel --env=GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=grafana-map-panel grafana/grafana:8.0.0 +docker run --publish=3000:3000 --volume=$PWD/dist:/var/lib/grafana/plugins/panodata-map-panel --env=GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=panodata-map-panel grafana/grafana:8.0.6 ``` Because the version of `node-sass` used as transitive dependency is apparently diff --git a/Makefile b/Makefile index 0e96aa1..17f6b59 100644 --- a/Makefile +++ b/Makefile @@ -16,11 +16,11 @@ publish: check-tools check-token $(eval version=$(shell cat package.json | jq --raw-output .version)) @# Create release on GitHub. - github-release release --user panodata --repo grafana-map-panel --tag $(version) || true + github-release release --user panodata --repo panodata-map-panel --tag $(version) || true @# Upload distribution package. - $(eval distfile=ci/packages/grafana-map-panel-$(version).zip) - github-release upload --user panodata --repo grafana-map-panel --tag $(version) --name $(notdir $(distfile)) --file $(distfile) + $(eval distfile=ci/packages/panodata-map-panel-$(version).zip) + github-release upload --user panodata --repo panodata-map-panel --tag $(version) --name $(notdir $(distfile)) --file $(distfile) check-tools: diff --git a/README.md b/README.md index 897496c..f11fcb1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,27 @@ -# Grafana Map Panel +# Panodata Map Panel -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. +## Background -![Grafana Map](https://raw.githubusercontent.com/grafana/worldmap-panel/54f83cfdc7339fee02df00933422c35630677330/src/images/worldmap-world.png) +The Panodata Map Panel is an enhanced and maintained friendly fork of the original [Grafana Worldmap Panel]. +We will be happy to receive feedback and contributions from the community at the [upstream discussion topic] +and on [GitHub]. +You are also encouraged to follow the development in more detail at [first steps], [Developing Grafana Worldmap NG] +and by reading the [changelog]. + +[changelog]: https://github.com/panodata/panodata-map-panel/blob/develop/CHANGELOG.md +[Developing Grafana Worldmap NG]: https://community.hiveeyes.org/t/grafana-worldmap-panel-ng/1824 +[first steps]: https://github.com/grafana/worldmap-panel/issues/197 +[GitHub]: https://github.com/panodata/panodata-map-panel +[Grafana Worldmap Panel]: https://github.com/grafana/worldmap-panel +[upstream discussion topic]: https://community.grafana.com/t/giving-the-grafana-worldmap-panel-some-love/17210 + + +## About + +The map panel displays 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. + +![Map example](https://raw.githubusercontent.com/grafana/worldmap-panel/54f83cfdc7339fee02df00933422c35630677330/src/images/worldmap-world.png) ## How this works (theory and examples) @@ -190,7 +209,7 @@ Similar to the Elasticsearch query above, 3 fields are expected (2 of them are m - A *geohash* field. This is used to calculate where the circle should be drawn. - 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. -The field mappings have to be specified on the Grafana Map settings tab. +The field mappings have to be specified on the "settings" tab. ![Example influxdb query](https://cloud.githubusercontent.com/assets/434655/16535977/8cd520be-3fec-11e6-8dc9-2ecf7b16ad5f.png) @@ -281,7 +300,7 @@ The threshold field also accepts 2 or more comma-separated values. For example, Optionally, you can show an image over the base map (but below the data points). This could be useful, for example, to show a more detailed/up-to-date image of the area of interest, in case the map provider only has old or low-resolution images. See below for an example of displaying interpolated sensor data (for example, temperatures in a field while only knowing the temperatures at a few sensors). -![Image overlay example](https://raw.githubusercontent.com/panodata/grafana-map-panel/develop/src/images/overlay_example.png) +![Image overlay example](https://raw.githubusercontent.com/panodata/panodata-map-panel/develop/src/images/overlay_example.png) **Enable overlay** @@ -307,4 +326,4 @@ Specify the limits of the image in the map. Enter the minimum and maximum latitu ### CHANGELOG -The latest changes can be found here: [CHANGELOG.md](https://github.com/panodata/grafana-map-panel/blob/master/CHANGELOG.md) +The latest changes can be found here: [CHANGELOG.md](https://github.com/panodata/panodata-map-panel/blob/develop/CHANGELOG.md) diff --git a/doc/backlog.rst b/doc/backlog.rst index 5f49248..6cb3c54 100644 --- a/doc/backlog.rst +++ b/doc/backlog.rst @@ -1,5 +1,5 @@ -######################### -Grafana Map Panel Backlog -######################### +########################## +Panodata Map Panel Backlog +########################## - "Zoom to fit data" option stopped working. diff --git a/package.json b/package.json index 14b8434..90fc049 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "grafana-map-panel", + "name": "panodata-map-panel", "version": "0.15.0", "description": "Map Panel", "scripts": { diff --git a/src/libs/leaflet_plus.ts b/src/libs/leaflet_plus.ts index 3d4e2c1..7372189 100644 --- a/src/libs/leaflet_plus.ts +++ b/src/libs/leaflet_plus.ts @@ -1,7 +1,7 @@ // 04bcb59 added an autoWidth setting to the Popup options. // This option, when disabled, will mask the whole section for computing // the width for the popup automatically within the _updateLayout method. -// https://github.com/panodata/grafana-map-panel/issues/79#issuecomment-723290476 +// https://github.com/panodata/panodata-map-panel/issues/79#issuecomment-723290476 import { Popup } from 'leaflet'; // @option autoWidth: Boolean = true diff --git a/src/partials/editor.html b/src/partials/editor.html index 975dde0..7ba2b74 100644 --- a/src/partials/editor.html +++ b/src/partials/editor.html @@ -2,25 +2,25 @@ The - - Grafana Map Panel NG + + Panodata Map Panel - (changes) - is work in progress. - - Enjoy - following the development - and testing it. - - We will be happy to receive feedback from the community at - [1], - [2] - and - [3]. - - Please don't use this software in production yet. + is an enhanced and maintained friendly fork of the original + Grafana Worldmap Panel. + + We will be happy to receive feedback and contributions from the community at the + upstream discussion topic + and on + GitHub. + + You are also encouraged to follow the development in more detail at + first steps, + Developing Grafana Worldmap NG + and by reading the + changelog.
@@ -31,7 +31,6 @@

Location source

-
Data format and mapping
diff --git a/src/plugin.json b/src/plugin.json index c1d7a96..b7b6e3d 100644 --- a/src/plugin.json +++ b/src/plugin.json @@ -1,22 +1,22 @@ { "type": "panel", - "name": "Map Panel", - "id": "grafana-map-panel", + "name": "Panodata Map Panel", + "id": "panodata-map-panel", "info": { - "description": "Grafana Map Panel. Displays time series data or geohash data on a world map.", + "description": "Panodata Map Panel, a descendant of the original Grafana Worldmap Panel. Displays time series data or geohash data on a world map.", "author": { "name": "Grafana Labs", "url": "https://grafana.com" }, - "keywords": ["map", "panel", "worldmap"], + "keywords": ["map", "panel"], "logos": { "small": "images/worldmap_logo.svg", "large": "images/worldmap_logo.svg" }, "links": [ - {"name": "Project site", "url": "https://github.com/panodata/grafana-map-panel"}, - {"name": "MIT License", "url": "https://github.com/panodata/grafana-map-panel/blob/master/LICENSE"} + {"name": "Project site", "url": "https://github.com/panodata/panodata-map-panel"}, + {"name": "MIT License", "url": "https://github.com/panodata/panodata-map-panel/blob/develop/LICENSE"} ], "screenshots": [ {"name": "World", "path": "images/worldmap-world.png"},