forked from grafana/grafonnet-lib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request grafana#206 from grafana/contributing-guide
Adds CONTRIBUTING.md
- Loading branch information
Showing
4 changed files
with
35 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters