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

History

shuting c1b1cbb7da Add PodSecurity description (#4475 ) Signed-off-by: ShutingZhao <shuting@nirmata.com> Signed-off-by: ShutingZhao <shuting@nirmata.com>		2022-09-01 09:03:41 +00:00
..
crd	Add PodSecurity description (#4475 )	2022-09-01 09:03:41 +00:00
template	restructure and generate HTML docs	2021-01-07 18:57:33 -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.