Uploaded image for project: 'OpenShift Virtualization'
  1. OpenShift Virtualization
  2. CNV-73476

CNV Doc improvements v4.22 edition

XMLWordPrintable

    • CNV doc improve 4.21
    • Product / Portfolio Work
    • 5
    • Hide

      Product documentation contains conceptual description of the feature, procedures to successfully introduce, configure and use the feature, and any applicable references. When possible, content is refactored into content journeys.

      The content shall be clear, concise, and meet CCS style and formatting guidelines.

      The content shall be accurate and pass the following quality reviews: technical (SME) review, peer review, and QE review.

      Show
      Product documentation contains conceptual description of the feature, procedures to successfully introduce, configure and use the feature, and any applicable references. When possible, content is refactored into content journeys. The content shall be clear, concise, and meet CCS style and formatting guidelines. The content shall be accurate and pass the following quality reviews: technical (SME) review, peer review, and QE review.
    • In Progress
    • VIRTSTRAT-205 - Documentation improvements FY2025
    • VIRTSTRAT-205Documentation improvements FY2025
    • Yes

      Goal

      There will be updates to the content to help users locate content and have a better documentation experience. Content enhancements will be added in the form of user-journey workflows or content journeys that describe a concept, configuration, procedures, and references to accomplish a task/workflow.

      User Stories

      • As a developer or cluster admin, I want to understand what product documentation is available to support me in my specific role, so that I can work successfully with OpenShift Virtualization.
        • The docs team is concentrated on Cluster Admins and VM Admins.
      • As a RH CCS associate, I want to ensure that new content meets ContentX goals and content is refactored into content journeys.

      Non-Requirements

      • List of things not included in this epic, to alleviate any doubt raised during the grooming process.

      Notes

      • Any additional details or decisions made/needed

          1.
          		 upstream roadmap issue Sub-task New Undefined Unassigned
          2.
          		 upstream design Sub-task New Undefined Unassigned
          3.
          		 upstream documentation Sub-task New Undefined Unassigned
          4.
          		 upgrade consideration Sub-task New Undefined Unassigned
          5.
          		 test plans in polarion Sub-task New Undefined Unassigned
          6.
          		 automated tests Sub-task New Undefined Unassigned
          7.
          		 downstream documentation merged Sub-task New Undefined Unassigned
          8.
          		 CNV QE DevOps Requirement/Enablement Sub-task New Undefined Unassigned

              ctomasko Catherine Tomasko
              rhn-support-sjess Sabrina Jess
              Sabrina Jess Sabrina Jess
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: