Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed Nov 7, 2019
1 parent 76c9567 commit 468cdca
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 18 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,25 @@

## development


## v0.6.4
- Update documentation


## v0.6.3
- Remove ci/ directory from .gitignore again


## v0.6.2
- Fix CircleCI recipe


## v0.6.1
- Update yarn.lock
- Update documentation
- Add Grafana 6.4.4 to CircleCI recipe


## v0.6.0
- Ignore "ci/" subfolder
- Use "canary" variant of @grafana/toolkit. Thanks @dprokop!
Expand Down
27 changes: 17 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,28 @@
# Building the Grafana Map Panel
# Hacking on the Grafana Map Panel

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

1. Install npm packages: `npx yarn install`
2. Build and lint the JavaScript: `npx yarn build`
2. Run the tests before submitting a PR: `npx yarn test`
3. A test watcher when TDD:ing: `npx yarn dev --watch`

Grafana will read in the `dist` folder first so to see your changes in
Grafana will read in the `dist` folder first. So, to see your changes in
Grafana, you will have to build the plugin once. However, you do not
need to restart your local Grafana server after every change, just
refreshing the page will be sufficient.

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

npx grafana-toolkit plugin:ci-package
## Development
1. Install packages: `npx yarn install`
2. Bundle plugin in dev mode: `npx yarn dev`
3. Bundle plugin in dev mode and start a watcher: `npx yarn watch`
4. Run the tests before submitting a PR: `npx yarn test`

When this process succeeds, packages can be found within the `ci/packages/` folder.

# Building the Grafana Map Panel
1. Install packages: `npx yarn install`
2. Build into `dist/`, lint and run tests: `npx yarn build`
3. Build plugin on CI: `npx grafana-toolkit plugin:ci-build`
4. Create a zip package: `npx grafana-toolkit plugin:ci-package`
When this process succeeds, packages can be found within the `ci/packages/` folder.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016 Grafana
Copyright (c) 2016-2019 Grafana Labs

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Grafana Map Panel
# Grafana Map Panel %VERSION%

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.

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

### CHANGELOG

The latest changes can be found here: [CHANGELOG.md](https://github.com/grafana/worldmap-panel/blob/master/CHANGELOG.md)
The latest changes can be found here: [CHANGELOG.md](https://github.com/panodata/grafana-map-panel/blob/master/CHANGELOG.md)
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "grafana-map-panel",
"version": "0.6.1",
"description": "Grafana Map Panel",
"version": "0.6.4",
"description": "Map Panel",
"scripts": {
"build": "grafana-toolkit plugin:build",
"test": "grafana-toolkit plugin:test",
Expand Down
6 changes: 3 additions & 3 deletions src/plugin.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
"name": "Grafana Labs",
"url": "https://grafana.com"
},
"keywords": ["worldmap", "panel"],
"keywords": ["map", "panel", "worldmap"],
"logos": {
"small": "images/worldmap_logo.svg",
"large": "images/worldmap_logo.svg"
},
"links": [
{"name": "Project site", "url": "https://github.com/panodata/grafana-worldmap-panel"},
{"name": "MIT License", "url": "https://github.com/panodata/grafana-worldmap-panel/blob/master/LICENSE"}
{"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"}
],
"screenshots": [
{"name": "World", "path": "images/worldmap-world.png"},
Expand Down

0 comments on commit 468cdca

Please sign in to comment.