Skip to content

Properly document and structure procedures  #402

Closed
@jc-berger

Description

@jc-berger

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

Metadata

Metadata

Assignees

Labels

area/documentationImprovements or additions to documentation

Type

No type

Projects

Status

Done ✅

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions