Skip to content

Commit

Permalink
Update repository documentation
Browse files Browse the repository at this point in the history
Make it clear that this is a somewhat divergent fork of the upstream
Grafana repository.
  • Loading branch information
rhowe committed Oct 30, 2022
1 parent f8ef1c2 commit 43c3245
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 12 deletions.
3 changes: 2 additions & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Code of Conduct

Grafonnet is developed within the Grafana community.
This fork of Grafonnet is maintained indepdently of Grafana, however it does
aim to operate within the Grafana community.

We are following the same Code of Conduct as Grafana (Contributor Covenant Code
of Conduct). Please find it [here][coc].
Expand Down
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Contributing

_The below contribution guide is taken from the original Grafana repository and
the sentiments expressed there apply equally here._

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
Expand All @@ -10,8 +13,8 @@ participants to adhere to it.

## Version Support

We strive to only support the latest and last major Grafana versions - currently
6 and 7.
We strive to only support the latest and last major Grafana versions -
currently 9.

## Feature Support

Expand Down
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,22 @@

Jsonnet libraries for writing Grafana dashboards as code.

[![CircleCI](https://circleci.com/gh/grafana/grafonnet-lib.svg?style=svg)](https://circleci.com/gh/grafana/grafonnet-lib)
This is a fork of grafonnet-lib from Grafana Labs, with improved support for
recent Grafana features.

_**Attention:** We're in the process of introducing generated code that can be
used instead of the manually maintained Jsonnet code in the
[grafonnet](./grafonnet) directory. The generated code lives in
[grafonnet-7.0](./grafonnet-7.0). It's generated from a new project,
Grafana's docs are here: https://grafana.github.io/grafonnet-lib/ although this
codebase has diverged somewhat from the API described there.

# Grafonnet 7

In the [grafonnet-7.0](./grafonnet-7.0) directory you will find code generated
from a new project,
[grafana/dashboard-spec](https://github.com/grafana/dashboard-spec). The
generated code is still incomplete, however, the components present are useable.
We very much appreciate contributions in
generated code is still incomplete, however, the components present are
useable. We very much appreciate contributions in
[grafana/dashboard-spec](https://github.com/grafana/dashboard-spec) for
components yet to be added._
components yet to be added.

See the full docs here: https://grafana.github.io/grafonnet-lib/

## Contributing

Expand Down

0 comments on commit 43c3245

Please sign in to comment.