CQA 2.1 - Feb doc-Migrating_your_virtual_machines

[anarnold97]

CQA 2.1 Assessment Report: doc-Migrating_your_virtual_machines

Summary report

Content Location: documentation/doc-Migrating_your_virtual_machines/
Date of Review: February 9, 2026
Vale Configuration: RedHat + AsciiDocDITA (write-good ignored per request)

---

Summary

Metric	Before Fixes	After Fixes
DITA Errors	2	0
Missing Short Descriptions	3	0
Style Warnings	75	72
Total Files Assessed	176	176
Pre-Migration Status	Does Not Meet Criteria	Meets Criteria

---

Fixes Applied

1. proc_storage-copy-offload-general-ssh-set-up.adoc

Problem: PROCEDURE module contained level 2 sections (==), which violate DITA task structure rules. DITA tasks cannot contain sections.

Errors Fixed:

• AsciiDocDITA.TaskSection: Sections are not allowed in DITA tasks (line 17)
• AsciiDocDITA.TaskSection: Sections are not allowed in DITA tasks (line 25)

Solution Applied:

• Changed content type from PROCEDURE to CONCEPT (the content was informational, not procedural)
• Updated module ID from proc_storage-copy-offload-general-ssh-set-up to con_storage-copy-offload-general-ssh-set-up
• Converted == Section headings to bold text (*Heading:*) to comply with DITA

Before:

:_mod-docs-content-type: PROCEDURE
[id="proc_storage-copy-offload-general-ssh-set-up_{context}"]
...
[id="storage-copy-offload-general-ssh-security_{context}"]
== Important notes and security considerations

After:

:_mod-docs-content-type: CONCEPT
[id="con_storage-copy-offload-general-ssh-set-up_{context}"]
...
*Important notes and security considerations:*

---

2. con_troubleshooting-storage-copy-offload.adoc

Problem: Missing [role="_abstract"] attribute for short description (required for DITA <shortdesc> element).

Error Fixed:

• AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as <shortdesc> in DITA

Solution Applied:

• Added [role="_abstract"] before the introductory paragraph

Before:

= Troubleshooting storage copy offload

This section describes problems that are unique to storage copy offload...

After:

= Troubleshooting storage copy offload

[role="_abstract"]
This section describes problems that are unique to storage copy offload...

---

3. master.adoc

Problem: Missing short description for the master assembly document.

Error Fixed:

• AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as <shortdesc> in DITA

Solution Applied:

• Added [role="_abstract"] with descriptive paragraph after the content type declaration

Before:

:_mod-docs-content-type: ASSEMBLY

include::modules/con_performing-migration-intro.adoc[leveloffset=+1]

After:

:_mod-docs-content-type: ASSEMBLY

[role="_abstract"]
This guide describes how to migrate virtual machines to {virt} by using {project-first}.

include::modules/con_performing-migration-intro.adoc[leveloffset=+1]

---

Pre-Migration Requirements Assessment (CQA 2.1)

Requirement	Status	Notes
Content passes AsciiDocDITA Vale check with no errors	PASS	0 errors after fixes
No text between include statements	PASS	Assemblies properly structured
Content is modularized	PASS	70 PROCEDURE, 45 CONCEPT, 32 REFERENCE modules
Modules use official templates	PASS	All use correct content types
All required modular elements present	PASS	Short descriptions now complete
Assemblies use official template	PASS	All 10 assemblies properly structured
Content not deeply nested (≤3 levels)	PASS	Max nesting is 3 levels
Short descriptions properly formatted	PASS	All modules have [role="_abstract"]
Titles are brief and descriptive	PASS	Titles follow conventions

[anarnold97]

@Jenny-Anne - updated. thanks