mirror of https://github.com/kyverno/kyverno.git synced 2024-12-14 11:57:48 +00:00

History

Charles-Edouard Brétéché 47b3704848 fix: missing elements in v2beta1 api (#4654 ) Signed-off-by: Charles-Edouard Brétéché <charled.breteche@gmail.com> Signed-off-by: Charles-Edouard Brétéché <charled.breteche@gmail.com>		2022-09-19 09:55:04 +00:00
..
crd	fix: missing elements in v2beta1 api (#4654 )	2022-09-19 09:55:04 +00:00
template	fix: api reference docs (#4490 )	2022-09-07 14:25:57 +08:00
config.json	fix: generated api reference docs (#3711 )	2022-04-28 12:51:44 +00:00
README.md	restructure and generate HTML docs	2021-01-07 18:57:33 -08:00

README.md

docs

This folder containers the generated CRD documentation in HTML format. It is referenced from the Kyverno website (https://kyverno.io/docs/crds/).

Building

Follow these steps to generate the docs:

Install gen-crd-api-reference-docs

clone https://github.com/ahmetb/gen-crd-api-reference-docs
cd gen-crd-api-reference-docs
go build
mv gen-crd-api-reference-docs $GOPATH/bin

Generate the HTML

gen-crd-api-reference-docs -api-dir ./pkg/api/kyverno/v1 \
    -config docs/config.json  \
    -template-dir docs/template/ \
    -out-file docs/crd/v1/index.html

If needed, update the docs site.