diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1b40b9f3..f7150abd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,9 +12,7 @@ Bugs or feature requests can go into [GitHub Issues](https://github.com/grafana/ ## Generation process -`make generate` will generate the library for the `LATEST` version, including the docs in `docs/`. It will also update `gen/grafonnet-latest` to point to this version. Use `make -B generate` to regenerate the latest version. This process depends on the schema's generated by [grok](https://github.com/grafana/grok/tree/main/jsonnet). - -`make -B -j4 regenerate` will regenerate all older versions. Note the `-j`, which means it will regenerate the different versions in parallel to speed up the process. +`make generate` will generate the library for the `LATEST` version, including the docs in `docs/`. It will also update `gen/grafonnet-latest` to point to this version. Use `make -B generate` to regenerate the latest version. This process depends on the [foundation-sdk](https://github.com/grafana/grafana-foundation-sdk). `make test` will run the `test/` suite on the `LATEST` version. diff --git a/README.md b/README.md index 9d2058e9..8a00cb27 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ Jsonnet library for generating Grafana dashboards. ## Introduction -This library is generated from JSON Schemas generated by [Grok](https://github.com/grafana/grok), -these schemas are generated directly from the Grafana repository to ensure Grafonnet can +This library is generated from OpenAPI documents in [grafana-foundation-sdk](https://github.com/grafana/grafana-foundation-sdk), +these are generated from the Grafana repository to ensure Grafonnet can keep up with Grafana development. Grafonnet is the spiritual successor of [grafonnet-lib](https://github.com/grafana/grafonnet-lib). diff --git a/docs/README.md b/docs/README.md index ca9f0fec..31aaa20b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,8 +10,8 @@ Jsonnet library for generating Grafana dashboards. ## Introduction -This library is generated from JSON Schemas generated by [Grok](https://github.com/grafana/grok), -these schemas are generated directly from the Grafana repository to ensure Grafonnet can +This library is generated from OpenAPI documents in [grafana-foundation-sdk](https://github.com/grafana/grafana-foundation-sdk), +these are generated from the Grafana repository to ensure Grafonnet can keep up with Grafana development. Grafonnet is the spiritual successor of [grafonnet-lib](https://github.com/grafana/grafonnet-lib). diff --git a/generator/patches/schemas.libsonnet b/generator/patches/schemas.libsonnet index 2e8f1a28..0acfa577 100644 --- a/generator/patches/schemas.libsonnet +++ b/generator/patches/schemas.libsonnet @@ -85,7 +85,7 @@ local utils = import '../utils.libsonnet'; }, }, - // Folder schema got removed from CUE/grok in https://github.com/grafana/grafana/pull/79413 + // Folder schema got removed from CUE in https://github.com/grafana/grafana/pull/79413 // This adds it back as it is a really simple object. getFolderSchema(version, schemas): local allSchemaTitles = std.map(function(x) x.info.title, schemas);