You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for your interest in contributing to this repository. We are glad you want to help us to improve the project and join our community.
4
-
Feel free to [browse the open issues](https://github.com/questdb/questdb-grafana-datasource/issues).
5
-
If you want more straightforward tasks to complete, [we have some](https://github.com/questdb/grafana-questdb-datasource/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
6
-
For more details about how you can help, please take a look at [Grafana’s Contributing Guide](https://github.com/questdb/grafana-questdb-datasource/blob/main/CONTRIBUTING.md).
4
+
Feel free to [browse the open issues](https://github.com/questdb/questdb-grafana-datasource/issues).
7
5
8
6
## Development setup
9
7
10
8
### Getting started
11
9
12
-
Clone this repository into your local environment. The frontend code lives in the `src` folder, alongside the [plugin.json file](https://grafana.com/docs/grafana/latest/developers/plugins/metadata/). The backend Go code is in the `pkg` folder. To build this plugin refer to [Build a plugin](https://grafana.com/docs/grafana/latest/developers/plugins/)
10
+
Clone this repository into your local environment. The frontend code lives in the `src` folder, alongside the [plugin.json file](https://grafana.com/docs/grafana/latest/developers/plugins/metadata/).
11
+
The backend Go code is in the `pkg` folder. To build this plugin refer to [plugin tools(https://grafana.com/developers/plugin-tools).
13
12
14
13
### Running the development version
15
14
16
-
Before you can set up the plugin, you need to set up your environment by following [Set up your environment](https://grafana.com/tutorials/build-a-data-source-backend-plugin/#set-up-your-environment).
15
+
Before you can set up the plugin, you need to set up your environment by installing:
@@ -24,6 +27,12 @@ mage test # run all Go test cases
24
27
mage build:backend && mage reloadPlugin # builds and reloads the plugin in Grafana
25
28
```
26
29
30
+
If host operating system is different from one used in grafana docker image use the following instead:
31
+
32
+
```sh
33
+
mage -v buildAll
34
+
```
35
+
27
36
#### Compiling the frontend
28
37
29
38
You can build and test the frontend by using `yarn`:
@@ -39,17 +48,10 @@ You can also have `yarn` watch for changes and automatically recompile them:
39
48
yarn watch
40
49
```
41
50
42
-
##Create a pull request
51
+
### Starting docker containers
43
52
44
-
Once you are ready to make a pull request, please read and follow [Create a pull request](https://github.com/grafana/grafana/blob/master/contribute/create-pull-request.md).
53
+
You can start grafana and questdb containers with:
45
54
46
-
## Build a release for the QuestDB data source plugin
47
-
48
-
You need to have commit rights to the GitHub repository to publish a release.
49
-
50
-
1. Update the version number in the `package.json` file.
51
-
2. Update the `CHANGELOG.md` by copy and pasting the relevant PRs
52
-
from [GitHub's Release drafter interface](https://github.com/questdb/grafana-questdb-datasource/releases/new) or by
53
-
running `npm run generate-release-notes`.
54
-
3. PR the changes.
55
-
4. Once merged, follow the Drone release process that you can find [here](https://github.com/grafana/integrations-team/wiki/Plugin-Release-Process#drone-release-proces)
0 commit comments