-
Task
-
Resolution: Done
-
Undefined
-
Future
-
False
-
None
-
False
-
-
-
No
1. - [x] Mandatory Add the required version to the Fix version/s field.
2. - [x] Mandatory Choose the type of documentation change.
- [ ] New topic in an existing section or new section
- [x] Update to an existing topic: https://github.com/stolostron/rhacm-docs/tree/2.10_stage/apis
3. - [x] Mandatory for GA content:
- [ ] Add link to dev story here: N/A
- [ ] Add steps and/or other important conceptual information here:
The API documentation comes directly from the APIs written by developers. With the completion of ACM-8278 to update the descriptions, an investigation into either restoring the original API documentation generation or using a similar solution would be worthwhile in order to save time and ensure consistency between the RHACM documentation and the RHACM code. Some options are:
- The original method can be found in the GitLab downstream scripts, using a swagger2markup-cli.jar Java executable (which I think might be this: https://swagger2markup.github.io/swagger2markup/1.3.3/ ):
- A cursory sample draft of the equivalent Openshift API doc generation can be found in this branch (alongside instructions):