Skip to content

Commit 638d182

Browse files
authored
update readme and documentation (#388)
* update root/readme and src/readme * update readme url
1 parent c85155f commit 638d182

File tree

2 files changed

+40
-5
lines changed

2 files changed

+40
-5
lines changed

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,32 @@
66
[![Downloads](https://img.shields.io/badge/dynamic/json?logo=grafana&color=F47A20&label=downloads&query=%24.items%5B%3F%28%40.slug%20%3D%3D%20%22marcusolsson-json-datasource%22%29%5D.downloads&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins)](https://grafana.com/grafana/plugins/marcusolsson-json-datasource)
77
[![License](https://img.shields.io/github/license/grafana/grafana-json-datasource)](LICENSE)
88

9-
> **Maintenance**: Now the plugin is being maintained by Grafana Labs. Big thanks to [Marcus Olsson](https://twitter.com/marcusolsson) for the awesome work!
9+
The Grafana JSON Datasource plugin empowers you to seamlessly integrate JSON data into Grafana. JSON is a versatile and widely used data format, and with this plugin, you can easily transform your JSON data into meaningful visualizations within Grafana dashboards.
1010

11-
A data source plugin for loading JSON APIs into [Grafana](https://grafana.com) using [JSONPath](https://goessner.net/articles/JsonPath/) or [JSONata](https://docs.jsonata.org/)
11+
## Documentation
1212

13-
![Screenshot](https://github.com/grafana/grafana-json-datasource/raw/main/src/img/dark.png)
13+
For comprehensive instructions on setting up and configuring the Grafana JSON API Datasource, please consult our official [documentation](https://grafana.github.io/grafana-json-datasource).
1414

15-
## Documentation
15+
## Contributing
16+
17+
We welcome and appreciate contributions from the open-source community to make this project better. Whether you want to report a bug, request a new feature, or submit code changes, please follow the guidelines below:
18+
19+
#### Reporting issues
20+
21+
If you encounter a bug or have a suggestion for improvement, please check our [issues](https://github.com/grafana/grafana-json-datasource/issues) to see if a similar issue has already been reported. If not, feel free to open a new issue. When creating an issue, please provide as much detail as possible, including the version of the datasource you are using, your version of grafana and steps to reproduce the issue.
22+
23+
#### Requesting features
24+
25+
If you have an idea for a new feature or enhancement, we encourage you to create an [issue](https://github.com/grafana/grafana-json-datasource/issues). This can help gather feedback and refine the proposal.
26+
27+
#### Pull requests
28+
29+
If you'd like to contribute code to this project, please follow these steps:
1630

17-
Full documentation for the plugin is available on the [website](https://grafana.github.io/grafana-json-datasource).
31+
1. Fork the repository to your GitHub account.
32+
2. Create a new branch for your feature or bug fix: `git checkout -b feature-name`.
33+
3. Make your changes and commit them with a clear, descriptive message.
34+
4. Push your branch to your fork: `git push origin feature-name`.
35+
5. Create a pull request (PR) to the `main` branch of this repository. Please provide a detailed description of your changes in the PR.
36+
6. Be prepared to address any feedback or requested changes during the review process.
37+
7. Once your PR is approved, it will be merged, and your contribution will be part of the datasource.

src/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# JSON API data source for Grafana
2+
3+
[![Build](https://github.com/grafana/grafana-json-datasource/workflows/CI/badge.svg)](https://github.com/grafana/grafana-json-datasource/actions?query=workflow%3A%22CI%22)
4+
[![Release](https://github.com/grafana/grafana-json-datasource/workflows/Release/badge.svg)](https://github.com/grafana/grafana-json-datasource/actions?query=workflow%3ARelease)
5+
[![Marketplace](https://img.shields.io/badge/dynamic/json?logo=grafana&color=F47A20&label=marketplace&prefix=v&query=%24.items%5B%3F%28%40.slug%20%3D%3D%20%22marcusolsson-json-datasource%22%29%5D.version&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins)](https://grafana.com/grafana/plugins/marcusolsson-json-datasource)
6+
[![Downloads](https://img.shields.io/badge/dynamic/json?logo=grafana&color=F47A20&label=downloads&query=%24.items%5B%3F%28%40.slug%20%3D%3D%20%22marcusolsson-json-datasource%22%29%5D.downloads&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins)](https://grafana.com/grafana/plugins/marcusolsson-json-datasource)
7+
[![License](https://img.shields.io/github/license/grafana/grafana-json-datasource)](LICENSE)
8+
9+
The Grafana JSON Datasource plugin empowers you to seamlessly integrate JSON data into Grafana. JSON is a versatile and widely used data format, and with this plugin, you can easily transform your JSON data into meaningful visualizations within Grafana dashboards.
10+
11+
## Documentation
12+
13+
For comprehensive instructions on setting up and configuring the Grafana JSON API Datasource, please consult our official [documentation](https://grafana.github.io/grafana-json-datasource).
14+
15+
> **Maintenance**: Now the plugin is being maintained by Grafana Labs. Big thanks to [Marcus Olsson](https://github.com/marcusolsson) for the awesome work!

0 commit comments

Comments
 (0)