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

CNV doc DITA migration module optimization

XMLWordPrintable

    • cnv_doc_DITA_optimize_modules
    • Quality / Stability / Reliability
    • 12
    • False
    • Hide

      None

      Show
      None
    • False
    • None
    • In Progress
    • VIRTSTRAT-476 - New documentation tools platform
    • VIRTSTRAT-476New documentation tools platform
    • 67% To Do, 0% In Progress, 33% Done

      Goal

      1. Review and split the complex modules into multiple modules for DITA compatibility.
        • Modules with multiple tables and a procedure must be parsed
        • DITA does not support a procedure inside of a reference module. The procedure must be it's own module.
        • Convert modules/virt-virtctl-commands to an assembly, with multiple reference modules and a procedure module. This is necessary to successfully migrate to DITA/AEM.
      2. Identify and archives modules that are not being actively used.
      3. Ensure that all links the virtualization content are full path links instead of relative anchor links.
      4.  

       

      User Stories

      • To prep for DITA migration, I want to ensure that large, complex modules are split into multiple modules for DITA compatibility and ease of managing those modules.
        • Complex modules with multiple tables and a procedure must be parsed.
        • Make procedures their own module.
      • As a writer, I do not want to migrate inactive content
      • As a writer, I want to make these changes to supported branches to reduce future cherrypicking conflicts.

      Non-Requirements

      • List of things not included in this epic, to alleviate any doubt raised during the grooming process.
      • No release notes or documentation is required. This work is concentrates on documentation structure and preparation for migrating to new DITA-based AEM tool.

      Notes

      • This work is not version specific

          There are no Sub-Tasks for this issue.

              ctomasko Catherine Tomasko
              ctomasko Catherine Tomasko
              Sabrina Jess
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: