Skip to content

Commit 9e32e87

Browse files
authored
Packaging and documentation tweaks for inclusion in the Grafana plugin registry (#29)
* plugin.json: add grafanaDependency * README: update variables link and mention date formats added in Grafana 7.1.2 * add screenshots to README and plugin.json
1 parent 449dea0 commit 9e32e87

12 files changed

Lines changed: 64 additions & 32 deletions

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,19 @@ format that can be parsed by `moment()` (e.g. ISO8601).
1414
* Nested types will be flattened into dot-delimited fields.
1515
* Grafana variables should be substituted directly in the query (instead of
1616
using GraphQL variables). The dashboard time ranges are available in the
17-
[global variables](https://grafana.com/docs/grafana/latest/variables/global-variables/)
18-
`$__from` and `$__to` as millisecond epoch.
17+
[global variables](https://grafana.com/docs/grafana/latest/variables/variable-types/global-variables/)
18+
`$__from` and `$__to` as millisecond epoch (or in whatever format is needed by the API
19+
in Grafana 7.1.2 or later).
1920
* Group by can be used to group elements into multiple data points.
2021
* Alias by is used to alter the name of the field displayed in the legend. `$field_<field.name>` is substituted with the
2122
values of the field and `$fieldName` is substituted with the name of the field.
2223

24+
# Screenshots
25+
26+
![DeutscheBahn Arrivals Table](https://user-images.githubusercontent.com/1627510/90258294-f1bf2b00-de0d-11ea-8768-34b4ef37c125.png)
27+
![DeutscheBahn Arrivals Annotations](https://user-images.githubusercontent.com/1627510/90258316-f8e63900-de0d-11ea-91eb-d40532d5b768.png)
28+
![GitHub Security Advisories](https://user-images.githubusercontent.com/1627510/90258319-fbe12980-de0d-11ea-8ea2-c97bbc398aa4.png)
29+
2330
# Examples
2431

2532
Below are some example queries demonstrating how to use the plugin. See the

dist/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,19 @@ format that can be parsed by `moment()` (e.g. ISO8601).
1414
* Nested types will be flattened into dot-delimited fields.
1515
* Grafana variables should be substituted directly in the query (instead of
1616
using GraphQL variables). The dashboard time ranges are available in the
17-
[global variables](https://grafana.com/docs/grafana/latest/variables/global-variables/)
18-
`$__from` and `$__to` as millisecond epoch.
17+
[global variables](https://grafana.com/docs/grafana/latest/variables/variable-types/global-variables/)
18+
`$__from` and `$__to` as millisecond epoch (or in whatever format is needed by the API
19+
in Grafana 7.1.2 or later).
1920
* Group by can be used to group elements into multiple data points.
2021
* Alias by is used to alter the name of the field displayed in the legend. `$field_<field.name>` is substituted with the
2122
values of the field and `$fieldName` is substituted with the name of the field.
2223

24+
# Screenshots
25+
26+
![DeutscheBahn Arrivals Table](https://user-images.githubusercontent.com/1627510/90258294-f1bf2b00-de0d-11ea-8768-34b4ef37c125.png)
27+
![DeutscheBahn Arrivals Annotations](https://user-images.githubusercontent.com/1627510/90258316-f8e63900-de0d-11ea-91eb-d40532d5b768.png)
28+
![GitHub Security Advisories](https://user-images.githubusercontent.com/1627510/90258319-fbe12980-de0d-11ea-8ea2-c97bbc398aa4.png)
29+
2330
# Examples
2431

2532
Below are some example queries demonstrating how to use the plugin. See the

dist/img/db_arrivals.png

102 KB
Loading
63 KB
Loading
134 KB
Loading

dist/module.js

Lines changed: 32 additions & 24 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/module.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/plugin.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,18 @@
1919
{ "name": "Website", "url": "https://github.com/fifemon/graphql-datasource" },
2020
{ "name": "License", "url": "https://github.com/fifemon/graphql-datasource/blob/master/LICENSE" }
2121
],
22-
"screenshots": [],
22+
"screenshots": [
23+
{ "name": "DeutscheBahn Arrivals", "path": "img/db_arrivals.png"},
24+
{ "name": "DeutscheBahn Arrivals Annotations", "path": "img/db_arrivals_annotations.png"},
25+
{ "name": "GitHub Security Advisories", "path": "img/github_security_advisories.png"}
26+
],
2327
"version": "1.1.2",
24-
"updated": "2020-07-01"
28+
"updated": "2020-08-14"
2529
},
2630

2731
"dependencies": {
2832
"grafanaVersion": "7.x.x",
33+
"grafanaDependency": ">=7.0.0",
2934
"plugins": []
3035
}
3136
}

src/img/db_arrivals.png

102 KB
Loading
63 KB
Loading

0 commit comments

Comments
 (0)