Skip to content
This repository was archived by the owner on Mar 11, 2024. It is now read-only.

Commit 05073fb

Browse files
authored
Add Application screenshot (#19)
1 parent 9b0a39e commit 05073fb

File tree

4 files changed

+31
-16
lines changed

4 files changed

+31
-16
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
- Update Workflows (#17)
88
- Rebuild using 9.3.6 (#18)
9+
- Add Application screenshot (#19)
910

1011
## 2.1.0 (2022-09-22)
1112

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# Template to create a new Grafana application plugin
22

3-
[![Grafana 9](https://img.shields.io/badge/Grafana-9.1.6-orange)](https://www.grafana.com)
4-
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/VolkovLabs/volkovlabs-abc-app.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/VolkovLabs/volkovlabs-abc-app/context:javascript)
3+
![Application](https://github.com/VolkovLabs/volkovlabs-abc-app/raw/main/src/img/app.png)
4+
5+
[![Grafana 9](https://img.shields.io/badge/Grafana-9.3.6-orange)](https://www.grafana.com)
56
![CI](https://github.com/volkovlabs/volkovlabs-abc-app/workflows/CI/badge.svg)
67
[![codecov](https://codecov.io/gh/VolkovLabs/volkovlabs-abc-app/branch/main/graph/badge.svg?token=2W9VR0PG5N)](https://codecov.io/gh/VolkovLabs/volkovlabs-abc-app)
8+
[![CodeQL](https://github.com/VolkovLabs/volkovlabs-abc-app/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/VolkovLabs/volkovlabs-abc-app/actions/workflows/codeql-analysis.yml)
9+
10+
The Abc Application is a template we created to streamline our development process and gladly share it with the Grafana community.
711

8-
## Introduction
12+
We created many Grafana applications to this moment. To make the creation process efficient, starting with a well-constructed template is always easier.
913

10-
The ABC Application is a template to create a new application plugin for Grafana.
14+
Generate an application template with [https://github.com/VolkovLabs/volkovlabs-abc-app/generate](https://github.com/VolkovLabs/volkovlabs-abc-app/generate).
1115

12-
### Requirements
16+
## Requirements
1317

14-
- Grafana 8.5+, Grafana 9.0+ is required for version 2.X.
15-
- Grafana 8.0+ is required for version 1.X.
18+
- **Grafana 8.5+, Grafana 9.0+** is required for version 2.X.
19+
- **Grafana 8.0+** is required for version 1.X.
1620

1721
## Getting Started
1822

@@ -30,32 +34,33 @@ yarn build
3034

3135
3. Sign the plugins if required
3236

33-
```
34-
export GRAFANA_API_KEY=erXXXX==
37+
```bash
38+
export GRAFANA_API_KEY=erfdfsgfs==
3539
yarn sign
3640
```
3741

38-
4. Start Docker container
42+
4. Start the Docker container
3943

4044
```bash
4145
yarn run start
4246
```
4347

4448
## Features
4549

46-
- Use `docker-compose` to start development environment with provisioned application, panels and dashboard.
50+
- Use `docker-compose` to start the development environment with a provisioned application, panels, and dashboard.
4751
- Provides unit test configuration.
4852
- Based on the latest version of Grafana.
4953
- Includes GitHub Actions for CI and Release.
5054
- Includes secure configuration for NGINX reverse proxy.
5155

5256
## Feedback
5357

54-
We love to hear from users, developers, and the whole community interested in this plugin. These are various ways to get in touch with us:
58+
We love to hear from you. There are various ways to get in touch with us:
5559

5660
- Ask a question, request a new feature, and file a bug with [GitHub issues](https://github.com/volkovlabs/volkovlabs-abc-app/issues/new/choose).
61+
- Sponsor our open-source plugins for Grafana with [GitHub Sponsor](https://github.com/sponsors/VolkovLabs).
5762
- Star the repository to show your support.
5863

5964
## License
6065

61-
- Apache License Version 2.0, see [LICENSE](https://github.com/volkovlabs/volkovlabs-abc-app/blob/main/LICENSE).
66+
Apache License Version 2.0, see [LICENSE](https://github.com/volkovlabs/volkovlabs-abc-app/blob/main/LICENSE).

src/img/app.png

47.2 KB
Loading

src/plugin.json

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,24 @@
1414
"keywords": ["template"],
1515
"links": [
1616
{
17-
"name": "Website",
18-
"url": "https://volkovlabs.io"
17+
"name": "Documentation",
18+
"url": "https://docs.volkovlabs.io"
19+
},
20+
{
21+
"name": "GitHub",
22+
"url": "https://github.com/volkovlabs/volkovlabs-abc-app"
1923
}
2024
],
2125
"logos": {
2226
"large": "img/logo.svg",
2327
"small": "img/logo.svg"
2428
},
25-
"screenshots": [],
29+
"screenshots": [
30+
{
31+
"name": "Panel",
32+
"path": "img/app.png"
33+
}
34+
],
2635
"updated": "%TODAY%",
2736
"version": "%VERSION%"
2837
},

0 commit comments

Comments
 (0)