Skip to content

Properly document and structure procedures #402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jc-berger opened this issue Mar 31, 2021 · 1 comment
Closed

Properly document and structure procedures #402

jc-berger opened this issue Mar 31, 2021 · 1 comment
Assignees
Labels
area/documentation Improvements or additions to documentation

Comments

@jc-berger
Copy link

jc-berger commented Mar 31, 2021

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:
#379
#380
#381
#382

Jira Issue: https://issues.redhat.com/browse/RHDEVDOCS-2891

@michael-valdron
Copy link
Member

#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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
Status: Done ✅
Development

No branches or pull requests

2 participants