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

History

Naman Lakhwani 9f3fc941ef [imageVerify]: adding `digestMutate` to simplify tag-to-digest mutation (#3531 ) * added digestMutate Signed-off-by: Naman Lakhwani <namanlakhwani@gmail.com> * rebase Signed-off-by: Naman Lakhwani <namanlakhwani@gmail.com> * setting always to true Signed-off-by: Naman Lakhwani <namanlakhwani@gmail.com> * small nit Signed-off-by: Naman Lakhwani <namanlakhwani@gmail.com> * make codegen Signed-off-by: Naman Lakhwani <namanlakhwani@gmail.com> * crds & failing rule if mutation fails Signed-off-by: Naman Lakhwani <namanlakhwani@gmail.com> * adding new func to fetch digest and changing naming to mutateDigest Signed-off-by: Naman Lakhwani <namanlakhwani@gmail.com> * small nits Signed-off-by: Naman Lakhwani <namanlakhwani@gmail.com> * generating crds Signed-off-by: Naman Lakhwani <namanlakhwani@gmail.com> * minor nit Signed-off-by: Naman Lakhwani <namanlakhwani@gmail.com> * correcting error format Signed-off-by: Naman Lakhwani <namanlakhwani@gmail.com> Co-authored-by: Jim Bugwadia <jim@nirmata.com>		2022-04-22 01:08:49 -07:00
..
crd	[imageVerify]: adding `digestMutate` to simplify tag-to-digest mutation (#3531 )	2022-04-22 01:08:49 -07:00
template	restructure and generate HTML docs	2021-01-07 18:57:33 -08:00
config.json	restructure and generate HTML docs	2021-01-07 18:57:33 -08: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.