grafana/pkg/codegen/tmpl
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
..
addenda.tmpl coremodels: Update to latest Thema with generics (#56602) 2022-10-11 09:45:07 +01:00
autogen_header.tmpl plugins: Introduce generated, static core plugin registry (#54118) 2022-09-14 10:15:09 -04:00
coremodel_imports.tmpl plugins: Introduce generated, static core plugin registry (#54118) 2022-09-14 10:15:09 -04:00
cuetsy_multi.tmpl codegen: Introduce TS codegen veneer (#54816) 2022-09-26 11:26:18 -04:00
docs.tmpl Codegen: Generate per-kind reference docs (#60416) 2023-01-16 13:55:40 +01:00
gen_header.tmpl Use preferred package header for generated code (#61059) 2023-01-06 04:57:45 -05:00
kind_core.tmpl Kindsys: Remove defs, Slot->SchemaInterface (#61069) 2023-01-06 12:37:32 -05:00
kind_registry.tmpl Kindsys: Remove Raw kind category (#60992) 2023-01-05 13:54:42 -05:00
plugin_lineage_binding.tmpl coremodels: Update to latest Thema with generics (#56602) 2022-10-11 09:45:07 +01:00
plugin_lineage_file.tmpl coremodels: Update to latest Thema with generics (#56602) 2022-10-11 09:45:07 +01:00
plugin_registry_ref.tmpl coremodels: Update to latest Thema with generics (#56602) 2022-10-11 09:45:07 +01:00
plugin_registry.tmpl coremodels: Update to latest Thema with generics (#56602) 2022-10-11 09:45:07 +01:00