Throughout our migration guides, we have a lot of procedures, but the major issue is that these procedures do not adhere to Red Hat's modular documentation requirements for procedures. We need to go through all our procedures and properly document and structure them so that they adhere to the modular documentations' requirements for procedures.
As a reference, see Red Hat's modular documentation guide which includes outlines and example of procedures.
381 is the only child left to complete this issue, with this being the case I'll separate #381 to close this one out and we will review #381 separately in refinement to determine priority.
michael-valdron
commented
6 months ago
Throughout our migration guides, we have a lot of procedures, but the major issue is that these procedures do not adhere to Red Hat's modular documentation requirements for procedures. We need to go through all our procedures and properly document and structure them so that they adhere to the modular documentations' requirements for procedures.
As a reference, see Red Hat's modular documentation guide which includes outlines and example of procedures.
See the issues for user stories as we tailor our procedures for user needs: https://github.com/devfile/api/issues/379 https://github.com/devfile/api/issues/380 ~https://github.com/devfile/api/issues/381~ https://github.com/devfile/api/issues/382
Jira Issue: https://issues.redhat.com/browse/RHDEVDOCS-2891