mirrors/kyverno
mirrors/kyverno
1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2025-03-13 19:28:55 +00:00
Code Activity
kyverno/docs
History
Prateek Pandey c2107a2946
fix: add char length validation for generate rule resource name (#3640) 
Signed-off-by: prateekpandey14 <prateek.pandey@nirmata.com>

Co-authored-by: shuting <shuting@nirmata.com>
Co-authored-by: Vyankatesh Kudtarkar <vyankateshkd@gmail.com>
2022-04-25 17:23:16 +08:00
..
crd fix: add char length validation for generate rule resource name (#3640) 2022-04-25 17:23:16 +08: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:

  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.