Add support for generating CRD docs (#2273)

* Add support for generating CRD docs * Correct typos in custom resource definitions Signed-off-by: Sanket Sudake <sanketsudake@gmail.com>
2021-11-30 15:54:53 +05:30
parent 24737e8958
commit fe0c1e3683
11 changed files with 48 additions and 46 deletions
@@ -82,6 +82,13 @@ generate-swagger-doc:
 generate-cli-docs:
 	go run tools/cmd-docs/main.go -o "../fission.io/content/en/docs/fission-cli"

+generate-crd-ref-docs:
+	# crd-ref-docs: https://github.com/elastic/crd-ref-docs
+	crd-ref-docs --source-path=pkg/apis/core/v1 --config=tools/crd-ref-docs/config.yaml --renderer markdown
+	cp tools/crd-ref-docs/header.md crd_docs.md
+	cat out.md >> crd_docs.md && rm out.md
+	cp crd_docs.md ../fission.io/content/en/docs/crd/_index.md
+
 all-generators: codegen generate-crds generate-swagger-doc

 skaffold-prebuild: