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

Properly document and structure procedures

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Obsolete
    • Icon: Normal Normal
    • Devfile 2.2
    • Devfile 2.2
    • Devfile Services
    • None
    • devex docs #199 Mar 25-Apr 15, devex docs #203 Jun 17-Jul 8, devex docs #205 Jul 29-Aug 19, devex docs #206 Aug 19-Sep 9
    • 8
    • Undefined

      Throughout our [migration guides](https://docs.devfile.io/devfile/2.1.0/user-guide/migrating-to-devfile-v2.html), 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](https://redhat-documentation.github.io/modular-docs/#modular-docs-procedure-examples) which includes outlines and example of procedures.

      Please reference the corresponding GitHub issue: [#402|https://github.com/devfile/api/issues/402.] 

      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

            Unassigned Unassigned
            jberger@redhat.com Jacob Berger
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: