Draft: Generate API documentation
What does this MR do?
Generate API documentation
- Add Makefile target
api-docsto generate API documentation using https://github.com/elastic/crd-ref-docs. - The generated config is expected to be checked in and linked from the Operator V2 documentation.
Changelog: added
Relates #29
Author's Checklist
For anything in this list which will not be completed, please provide a reason in the MR discussion.
Required
-
Ensure a release milestone is set. -
MR title and description are up to date, accurate, and descriptive. -
MR targeting the appropriate branch. -
MR has a green pipeline on GitLab.com. -
When ready for review, MR is labeled workflowready for review per the MR workflow.
Expected
-
Test plan indicating conditions for success has been posted and passes. -
Documentation is created or updated. -
Tests are added.