Skip to content

Commit

Permalink
docs: replace grok with foundation-sdk (#200)
Browse files Browse the repository at this point in the history
  • Loading branch information
Duologic authored May 24, 2024
1 parent 40f903c commit 37f859a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 8 deletions.
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion generator/patches/schemas.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down

0 comments on commit 37f859a

Please sign in to comment.