mirrors/kyverno
1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2024-12-14 11:57:48 +00:00
Code Activity
kyverno/docs
History
shuting 4d90b7b561
Update PSa images dsecription (#4840) 
Signed-off-by: ShutingZhao <shuting@nirmata.com>

Signed-off-by: ShutingZhao <shuting@nirmata.com>
2022-10-07 08:09:31 +00:00
..
controllers docs: add policy cache controller docs (#4714) 2022-09-28 13:08:26 +00:00
crd Update PSa images dsecription (#4840) 2022-10-07 08:09:31 +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:

  1. 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
  1. 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
  1. If needed, update the docs site.