mirrors/kyverno
1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2024-12-15 17:51:20 +00:00
Code Activity
kyverno/docs
History
Jim Bugwadia ba1be6b143 restructure and generate HTML docs
2021-01-07 18:57:33 -08:00
..
crd/v1 restructure and generate HTML docs 2021-01-07 18:57:33 -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.