diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..8318cc65 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contributing + +Thank you for your interest in contributing to Grafonnet! We welcome all people +who want to contribute in a healthy and constructive manner within our +community. Grafonnet is developed within the Grafana community. Therefore we +are following the same [Code of Conduct as +Grafana](https://github.com/grafana/grafana/blob/master/CODE_OF_CONDUCT.md). To +help us create a safe and positive community experience for all, we require all +participants to adhere to it. + +## Plugin Scope + +**Grafonnet only aims to support core features and plugins.** + +While Grafonnet itself only supports core Grafana functionality, we strongly +encourage development and use of community Grafonnet extensions. See the +[Community Plugins](https://grafana.github.io/grafonnet-lib/community-plugins/) +page for more info on this. diff --git a/README.md b/README.md index bc6d6cf7..8dfd60fd 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ A Jsonnet library for generating Grafana dashboards. See the full docs here: https://grafana.github.io/grafonnet-lib/ -## Code of Conduct +## Contributing -Grafonnet is developed within the Grafana community. Therefore we are following -the same [Code of Conduct as -Grafana](https://github.com/grafana/grafana/blob/master/CODE_OF_CONDUCT.md). You -need to agree and follow the code of conduct when you contribute to Grafonnet. +Please contribute! If you're interested, please start by reading the +[contributing guide](CONTRIBUTING.md). Before you begin work please take note of +our code of conduct and ensure that what you'd like to contribute is within the +scope of what Grafonnet attempts to support. diff --git a/docs/community-plugins.md b/docs/community-plugins.md index dbb26ed7..f175c1a7 100644 --- a/docs/community-plugins.md +++ b/docs/community-plugins.md @@ -1,20 +1,20 @@ # Community Plugins -Jsonnet makes it easy to patch an existing library. -Although Grafonnet only supports core Grafana features, -it is easy to extend it with additional 'plugins', which are -simply directories of libsonnet files, and can be used like -so: +Jsonnet makes it easy to patch an existing library. Although Grafonnet only +supports core Grafana features and plugins, it is easy to extend. For example: ```jsonnet local grafonnet = (import 'grafonnet-lib/grafana.libsonnet') - + (import 'my-plugin-lib/my-plugin.libsonnet'); + + (import 'my-plugin-lib/my-plugin.libsonnet'); { - ....our dashboards + ... } ``` ## Plugin List +If you've developed a Grafonnet extension for supporting a community plugin, +please submit a pull request to get it added to this list. + * [Status panel (by Vonage)](https://grafana.com/grafana/plugins/vonage-status-panel) template plugin: [link](https://github.com/DifferentialOrange/grafonnet-status-panel). * [Statusmap panel (by Flant)](https://grafana.com/grafana/plugins/flant-statusmap-panel) template plugin: [link](https://github.com/blablacar/grafonnet-lib-plugins). diff --git a/docs/index.md b/docs/index.md index 545bd33a..309c098c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,13 +23,12 @@ that would not be covered by Grafonnet already. ## Scope -Grafonnet aims at supporting any basic feature of dashboards (annotations, -templates, rows, panels...) as well as a number of datasources and plugins. +Grafonnet aims to support any basic feature of dashboards (annotations, +templates, rows, panels...) as well as a number of datasources and plugins. That +is, core Grafana features and plugins only. -We'd like to limit the Grafana plugins supported in Grafonnet to only official plugins. - -We do, however, encourage development and use of community Grafonnet plugins. -See the [Community Plugins page](community-plugins) for more info on this. +We do, however, encourage development and use of community Grafonnet extensions. +See the [Community Plugins](community-plugins) page for more info on this. ## Code of Conduct