Skip to content

Commit

Permalink
chore: fix warnings in submission
Browse files Browse the repository at this point in the history
  • Loading branch information
zitsen committed Oct 19, 2021
1 parent d8b2dbc commit e25f366
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 28 deletions.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# CONTRIBUTING

Start your Grafana plugin develop by following the [6 tips for improving your Grafana plugin before you publish](https://grafana.com/blog/2021/01/21/6-tips-for-improving-your-grafana-plugin-before-you-publish/).


## Development Setup

This plugin requires node >=12.0.0 and Go >= 1.7 .

```sh
npm install -g yarn
yarn install
yarn build
```

In order to use the build target provided by the plug-in SDK, you can use the [mage](https://github.com/magefile/mage) build file. After the build is complete, copy mage to $PATH.

```sh
git clone https://github.com/magefile/mage ../mage
cd ../mage
go run bootstrap.go
```

Run the following to update Grafana plugin SDK for Go dependency to the latest minor version:

```sh
go get -u github.com/grafana/grafana-plugin-sdk-go
go mod tidy
```

[Build backend plugin binaries](https://grafana.com/tutorials/build-a-data-source-backend-plugin/) for Linux, Windows and Darwin to dist directory:

```sh
mage -v
```
25 changes: 0 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,31 +21,6 @@ sudo service grafana-server restart
sudo systemctl start grafana-server
```

### Dev setup

This plugin requires node >=12.0.0 and Go >= 1.7
```
npm install -g yarn
yarn install
yarn build
```
In order to use the build target provided by the plug-in SDK, you can use the [mage](https://github.com/magefile/mage) build file. After the build is complete, copy mage to $PATH.
```
git clone https://github.com/magefile/mage ../mage
cd ../mage
go run bootstrap.go
```
Run the following to update Grafana plugin SDK for Go dependency to the latest minor version:

```
go get -u github.com/grafana/grafana-plugin-sdk-go
go mod tidy
```
[Build backend plugin binaries](https://grafana.com/tutorials/build-a-data-source-backend-plugin/) for Linux, Windows and Darwin to dist directory:
```
mage -v
```

### Attention
Since version 3.1.0, it began to support the alert function of grafana, but currently its sql statement only supports two variables: `$from` and `$to`.
When using grafana's alert function, you must use `SQL` as the `Type` option. In addition, only `ALIAS BY` and `INPUT SQL` are valid.
Expand Down
5 changes: 2 additions & 3 deletions src/plugin.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,13 @@
},
"links": [
{ "name": "GitHub", "url": "https://github.com/taosdata/grafanaplugin" },
{ "name": "AGPL-3.0", "url": "https://github.com/taosdata/grafanaplugin/LICENSE" }
{ "name": "AGPL-3.0", "url": "https://github.com/taosdata/grafanaplugin/blob/master/LICENSE" }
],
"version": "3.1.0",
"updated": "2021-10-18"
},

"dependencies": {
"grafanaDependency": "7.0.0",
"grafanaVersion": "5.2.4"
"grafanaDependency": ">=6.2.0"
}
}

0 comments on commit e25f366

Please sign in to comment.