Skip to content

Commit a6052d4

Browse files
authored
Merge pull request #200 from sasaki77/doc
DOC: update configuration and development
2 parents 07069e7 + 33311d4 commit a6052d4

File tree

6 files changed

+51
-34
lines changed

6 files changed

+51
-34
lines changed

README.md

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -94,52 +94,55 @@ This data source plugin consists of both frontend and backend components.
9494

9595
### Front-end Development
9696

97-
Node version v12.x is recommended. If you're new to the Node.js ecosystem, [Node Version Manager](https://github.com/nvm-sh/nvm) is a good place to start for managing different Node.js installations and environments.
97+
LTS version of Node.js is recommended. If you're new to the Node.js ecosystem, [Node Version Manager](https://github.com/nvm-sh/nvm) is a good place to start for managing different Node.js installations and environments.
98+
99+
[Grafana's plugin tools](https://grafana.com/developers/plugin-tools/) is used to develop the plugin. Please refer the documentation for more information.
98100

99-
[grafana-toolkit](https://github.com/grafana/grafana/tree/master/packages/grafana-toolkit) is used to develop the plugin. Please refer grafana-toolkit documentation for more information.
100101

101102
1. Begin by installing Yarn (https://yarnpkg.com/)
102-
```bash
103-
npm install -g yarn
104-
```
103+
```bash
104+
npm install -g yarn
105+
```
105106

106107
2. Install dependencies
107-
```bash
108-
yarn install
109-
```
108+
```bash
109+
yarn install
110+
```
110111

111112
3. Build plugin in development mode or run in watch mode
112-
```bash
113-
yarn dev
114-
```
115-
or
116-
```bash
117-
yarn watch
118-
```
113+
```bash
114+
yarn dev
115+
```
116+
117+
or
118+
119+
```bash
120+
yarn watch
121+
```
119122
4. Build plugin in production mode
120-
```bash
121-
yarn build
122-
```
123+
```bash
124+
yarn build
125+
```
123126

124127
### Back-end Development
125128

126129
If the Mage build tool is not already installed, you may install it using the installation instructions on the [Mage homepage](https://magefile.org/)
127130

128131
1. Update [Grafana plugin SDK for Go](https://grafana.com/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/) dependency to the latest minor version:
129132

130-
```bash
131-
go get -u github.com/grafana/grafana-plugin-sdk-go
132-
```
133+
```bash
134+
go get -u github.com/grafana/grafana-plugin-sdk-go
135+
```
133136

134137
2. Build backend plugin binaries for Linux, Windows and Darwin:
135-
```bash
136-
mage -v
137-
```
138+
```bash
139+
mage -v
140+
```
138141

139142
3. List all available Mage targets for additional commands:
140-
```bash
141-
mage -l
142-
```
143+
```bash
144+
mage -l
145+
```
143146

144147
## Build documentation
145148

docs/configuration.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ After installing plugin you can add Archiver Appliance datasource.
55
To add Archiver Appliance datasource, follow the below steps.
66

77
1. Open `Data Sources` in the side menu.
8-
2. Click `Add data source`.
8+
2. Click `Add new data source`.
99
3. Select `ArchiverAppliacne` in the list.
1010

1111
![Add new datasrouce](./img/aa-configuration-add-datasource.png)
@@ -14,19 +14,33 @@ Please refer [How to add a data source](https://grafana.com/docs/grafana/latest/
1414
more information.
1515

1616
## Datasource Settings
17+
1718
![Datasrouce settings](./img/aa-configuration-datasource-settings.png)
1819

19-
### HTTP
20+
### Connection
21+
2022
- **URL:** sets `retrieval url` end with retrieval.
23+
24+
### Authentication
25+
26+
Basically, no need to configure.
27+
28+
### Advanced settings
29+
30+
![Advanced settings](./img/aa-configuration-datasource-advanced-settings.png)
31+
32+
#### Advanced HTTP settings
33+
2134
- **Allowed Cookies:** no need to configure.
2235
- **Timeout:** sets HTTP request timeout in seconds if you need.
2336

24-
### Auth
25-
Basically, no need to configure.
37+
#### Data Retrieval Options
2638

27-
### Misc
2839
- **Use Backend:** enables GO backend to retrieve the archive data for visualization. The archived data is retrieved and processed on Grafana server, then the data is sent to Grafana client.
2940
- **Default Operator:** controls the default operator for processing of data during data retrieval.
3041
- **Hide Invalid:** hides the sample data whose severity is invalid with a null value. This feature is only effective if you are using the backend data retrieval.
42+
43+
#### Live Feature Options
44+
3145
- **Use live feature:** enables live updating with PVWS WebSocket server.
3246
- **PVWS URI:** sets the URI for the PVWS WebSocket server.

docs/development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ This data source plugin consists of both frontend and backend components.
55

66
### Front-end Development
77

8-
Node version v12.x is recommended. If you're new to the Node.js ecosystem, [Node Version Manager](https://github.com/nvm-sh/nvm) is a good place to start for managing different Node.js installations and environments.
8+
LTS version of Node.js is recommended. If you're new to the Node.js ecosystem, [Node Version Manager](https://github.com/nvm-sh/nvm) is a good place to start for managing different Node.js installations and environments.
99

10-
[grafana-toolkit](https://grafana.com/developers/plugin-tools/) is used to develop the plugin. Please refer grafana-toolkit documentation for more information.
10+
[Grafana's plugin tools](https://grafana.com/developers/plugin-tools/) is used to develop the plugin. Please refer the documentation for more information.
1111

1212
1. Begin by installing Yarn ([https://yarnpkg.com/](https://yarnpkg.com/))
1313
```bash
20.5 KB
Loading
41.9 KB
Loading
5.68 KB
Loading

0 commit comments

Comments
 (0)