1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2025-03-05 07:26:55 +00:00
kyverno/docs
Vyankatesh Kudtarkar aa6abd99f2
Support V2beta1 Version (#4514)
introduce new version V2beta1 which remove deprecated CRD 
types from version v1.

Signed-off-by: Vyankatesh <vyankateshkd@gmail.com>
2022-09-08 11:19:16 +00:00
..
crd Support V2beta1 Version (#4514) 2022-09-08 11:19:16 +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

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.