Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-5075

PAC: Update the content to follow writing guidelines and standards

XMLWordPrintable

    • 8
    • Documentation (Ref Guide, User Guide, etc.)
    • ---
    • ---

      You can see two PRs listed in the description. All of the SME, QE, and peer-review comments are included in the Original PR. As we were unable to continue working on the Original PR, the Second PR was created specifically to address the peer-review comments.

       

      Original PR that has peer-review comments: https://github.com/openshift/openshift-docs/pull/53813

      Comments we need to address?

       

      What do we need to do?

      For all the links mentioned above, consider moving the content into modules and additional references. This will help stick to the writing guidelines and standards.

      Points to consider:

      • The procedure can only have 3 levels. Please fix wherever you see similar occurrences and fix them in this PR.
      • As per the Red Hat style guide: You can nest lists, but try to keep the number of levels to two or fewer.
      • IBM style guide: Avoid writing excessively long procedures. Try to break up long procedures into smaller tasks. Procedural steps should have no more than two levels; restructure the information instead.

       

      Second PR that got created when addressing the remaining peer-review comments: https://github.com/openshift/openshift-docs/pull/57455

       

       

              Unassigned Unassigned
              gtrivedi@redhat.com Gaurav Trivedi
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: