-
Epic
-
Resolution: Unresolved
-
Critical
-
CNV v4.16.0, CNV v4.17.0, CNV v4.18.0, CNV v4.19.0, CNV v4.20.0
-
cnv_doc_DITA_optimize_modules
-
Quality / Stability / Reliability
-
12
-
False
-
-
False
-
None
-
Green
-
In Progress
-
VIRTSTRAT-476 - New documentation tools platform
-
-
14% To Do, 71% In Progress, 14% Done
-
Goal
- 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.
- Identify and archives modules that are not being actively used.
- Ensure that all links the virtualization content are full path links instead of relative anchor links.
- Ensure that new chapters contain an abstract or short description and that sections are not blank.
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.
- To prep for DITA migration, I want to ensure that all sections contain an abstract or short description, and that they are not blank.
- 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.
- No QE required if procedures are not changing. QE does not need to approve simple short descriptions or reorganization of content.
- Peer review is not required as long as the writer meets all style guide and passes VALE validation, and is confident that content meets CCS writing standards. Peer review is optional. You can request a peer review if you want.
Notes
- Dita migration work applies to supported all supported versions.
1.
|
upstream roadmap issue |
|
Closed | |
Unassigned |
2.
|
upstream design |
|
Closed | |
Unassigned |
3.
|
upstream documentation |
|
Closed | |
Unassigned |
4.
|
upgrade consideration |
|
Closed | |
Unassigned |
5.
|
test plans in polarion |
|
Closed | |
Unassigned |
6.
|
automated tests |
|
Closed | |
Unassigned |
7.
|
downstream documentation merged |
|
Closed | |
Unassigned |
8.
|
CNV QE DevOps Requirement/Enablement |
|
Closed | |
Unassigned |