1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2024-12-15 17:51:20 +00:00

restructure and generate HTML docs

This commit is contained in:
Jim Bugwadia 2021-01-07 18:57:33 -08:00
parent e7a04b9138
commit ba1be6b143
8 changed files with 1901 additions and 1 deletions

View file

@ -9,7 +9,7 @@
[![GitHub Repo stars](https://img.shields.io/github/stars/kyverno/kyverno)](https://github.com/kyverno/kyverno/stargazers) [![GitHub Repo stars](https://img.shields.io/github/stars/kyverno/kyverno)](https://github.com/kyverno/kyverno/stargazers)
<a href="https://kyverno.io" rel="kyverno.io">![logo](documentation/images/Kyverno_Horizontal.png)</a> <a href="https://kyverno.io" rel="kyverno.io">![logo](img/Kyverno_Horizontal.png)</a>
<p class="callout info" style="font-size: 2000%;"> <p class="callout info" style="font-size: 2000%;">
Kyverno is a policy engine designed for Kubernetes. It can validate, mutate, and generate configurations using admission controls and background scans. Kyverno policies are Kubernetes resources and do not require learning a new language. Kyverno is designed to work nicely with tools you already use like kubectl, kustomize, and Git. Kyverno is a policy engine designed for Kubernetes. It can validate, mutate, and generate configurations using admission controls and background scans. Kyverno policies are Kubernetes resources and do not require learning a new language. Kyverno is designed to work nicely with tools you already use like kubectl, kustomize, and Git.

27
docs/README.md Normal file
View file

@ -0,0 +1,27 @@
# 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](https://github.com/ahmetb/gen-crd-api-reference-docs)
```shell
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
```
2. Generate the HTML
```shell
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
```
3. If needed, update the [docs site](https://kyverno.io/docs/crds/).

1873
docs/crd/v1/index.html Normal file

File diff suppressed because it is too large Load diff

View file

Before

Width:  |  Height:  |  Size: 132 KiB

After

Width:  |  Height:  |  Size: 132 KiB