Doc: generated API #2274
Doc: generated API #2274
Conversation
The gen_crd_api.sh script will use https://github.com/ahmetb/gen-crd-api-reference-docs project to autogenerate CRD API from source code Ref apache#1137
We'll have to be more disciplined and comment properly throughout the code. We have many bold spots... in any case it's a good start I guess :) |
Right. This what makes me excited about finally having the documentation generated out of the CRDs. It help raising awareness that the CRDs are APIs, that deserve proper documentation! |
|
@zregvart just a heads-up in case you want to chime in? |
|
A good followup would be to convert the templates to asciidoc instead of using HTML here, not sure if/how it'll render on the website. |
Yeah, right now it's just a quick way to start it. I'd include follow up issues in order to go ahead and refine iteratively once we merge this. |
|
There are a few broken links, list can be seen in this website build. |
With this PR we introduce a new script which is in charge to generate an html single page with the definition of the API. We use the project https://github.com/ahmetb/gen-crd-api-reference-docs by temporary downloading the binary needed to run the generation.
I've changed the
generate-docprocedure to include the execution of this script that will update the API definition file as expected by the documentationWe include that file in a document that will be exposed in the documentation.
Close #1137
Release Note