grafana/pkg/codegen
Tania 045a12047f
Codegen: Generate per-kind reference docs (#60416)
* Add docs generator

* Add json-to-md conversion

* Fix lint issues

* Remove check for kind type

* Disable prettier for generated docs

* Use schema ref names as identifiers for links & headers

* Display the default value (if so) in the description

* Undo 'draft:false' introduced by mistake

* Update pkg/codegen/jenny_docs.go

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Undraft and unlist kinds documentation  (#61476)

* Support running containers without root daemon

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Use section shortcode to automatically list child pages

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Undraft and unlist kinds documentation

This page and child pages are directly accessible but are not listed
in the table of contents.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add docs-preview to browse drafted pages

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Replace end of line and pipe characters in table codegen

* Remove draft status from generated docs

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Joan López de la Franca Beltran <joanjan14@gmail.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Robert Horvath <robert.horvath@grafana.com>
2023-01-16 13:55:40 +01:00
..
tmpl Codegen: Generate per-kind reference docs (#60416) 2023-01-16 13:55:40 +01:00
astmanip_test.go Reconcile coremodels, entities, objects under new kind framework (#56492) 2022-11-10 12:36:40 -08:00
coremodel.go plugindef: Move pluginmeta out of coremodels as standalone thema lineage (#56765) 2022-11-15 14:48:31 +01:00
diffwrite.go schema: Generate Go and Typescript from Thema coremodels (#49193) 2022-05-27 03:21:37 +02:00
generators.go Codegen: Generate per-kind reference docs (#60416) 2023-01-16 13:55:40 +01:00
jenny_basecorereg.go Kindsys: Remove defs, Slot->SchemaInterface (#61069) 2023-01-06 12:37:32 -05:00
jenny_corekind.go Kindsys: Remove defs, Slot->SchemaInterface (#61069) 2023-01-06 12:37:32 -05:00
jenny_docs.go Codegen: Generate per-kind reference docs (#60416) 2023-01-16 13:55:40 +01:00
jenny_eachmajor.go Schema: Fix iterator for MajorsOrX (#61363) 2023-01-12 09:39:23 -05:00
jenny_gotypes.go deps: Update thema, use CUE fork (#60496) 2022-12-22 07:20:02 -05:00
jenny_tstypes.go codegen: Refactor core jennies for reusability, add version-picking metajennies (#58995) 2022-11-22 15:00:29 +01:00
jenny_tsveneerindex.go Kindsys: Remove Raw kind category (#60992) 2023-01-05 13:54:42 -05:00
latest_jenny.go Kindsys: Remove Raw kind category (#60992) 2023-01-05 13:54:42 -05:00
tmpl.go Kindsys: Remove defs, Slot->SchemaInterface (#61069) 2023-01-06 12:37:32 -05:00
util_go.go Codegen: Add support for optional maps (#60883) 2023-01-03 09:12:48 +02:00