Details
-
Task
-
Resolution: Unresolved
-
Major
-
None
-
None
-
None
-
1
Description
K8S-1897 provides the method for auto-generating Operator reference web documentation from source code. The source code side needs to have a well-defined and consistent format that caters to both the command-line and web presentations, but also doesn't overly complicate the auto-generation script. This is particularly important now that we've eliminated examples and merged the field rules with the descriptions.
The point of this ticket is to essentially create a template that developers and writers can follow for adding documentation to the source code. For example, we should decide whether the field rules should come at the beginning or end of the description, as well as specify various formatting requirements for the descriptions themselves.
Attachments
Issue Links
- relates to
-
K8S-1897 Autogenerate Reference Documentation
- Closed