[OSDOCS-17008] CQA 2.1 for vSphere IPI installation requirements

[maxwelldb]

Version(s): 4.20+

Issue: OSDOCS-17008

Link to docs preview: 4.20+

QE review:

• QE has approved this change.

Additional information: CQA pre-migration pass for the installation requirements assembly. Includes unwrapping collapsible vCenter privilege tables and converting hardbreaks cells to bullet lists, since DITA doesn't support either.

[openshift-ci-robot]

@maxwelldb: This pull request references OSDOCS-17008 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "5.0.0" version, but no target version was set.

Details

In response to this:

What

CQA 2.0/2.1 pre-migration pass for installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc and its included modules, part of OSDOCS-17008 (vSphere IPI, under epic OSDOCS-16987 / INSTALL-6).

Changes

• Added missing [role="_abstract"] short descriptions to the assembly and its included REFERENCE/CONCEPT modules.
• Stripped prose from the assembly's existing Additional resources block down to bare xrefs, clearing RelatedLinks.
• modules/installation-vsphere-installer-infra-requirements.adoc (the bulk of this PR):
• Unwrapped all 7 [%collapsible] blocks around the vCenter privilege tables. DITA/docs.rh doesn't support collapsible blocks, so per CQA-pass-criteria.md's ExampleBlock guidance, the wrapper is removed and the table content kept as is.
• Converted all [%hardbreaks] table cells listing multiple privileges into bullet lists (DITA doesn't support forced line breaks). Cells with only one item just had the now-unused [%hardbreaks] attribute removed. Verified the converted item count (332 bulleted + 9 single-item = 341) matches the original 341 backtick-quoted privileges exactly, so nothing was dropped.
• Promoted the two === subsections ("Required IP addresses", "DNS records") to == to clear NestedSection — DITA doesn't support === headings at all.
• modules/installation-vsphere-installer-infra-static-ip-nodes.adoc:
• Added the module's missing top-level = title — it previously started directly at ==, tripping DocumentTitle.
• Converted the <1>-<4> CalloutList callouts on the install-config.yaml sample into a where: definition list, ordered by first appearance in the code block, per the callout-conversion rules in CQA-pass-criteria.md.

Deliberately left as is

A pre-existing content typo (`VApp.Import`minimum`) in installation-vsphere-installer-infra-requirements.adoc is unrelated to Vale/DITA and out of scope for this CQA pass — flagging separately, not fixing here.

Verification

• vale --config=.vale-test.ini (AsciiDocDITA package) is clean, aside from the known NoXrefInModules false positive on the properly-formed Additional resources block.
• Rendered the assembly with asciidoctor -d book; the only remaining render error (installation-vsphere-installer-network-requirements.adoc incomplete table row) is pre-existing and unrelated to this change (confirmed by rendering the unmodified file from main).
• Rendered the static-IP module standalone and grepped <dt class="hdlist1"> to confirm all 4 where: terms render.

No technical/content meaning changed; this is a structural CQA pass only.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[ocpdocs-previewbot]

🤖 Mon Jul 13 18:41:26 - Prow CI generated the docs preview:

https://115240--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.html
https://115240--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_vsphere/upi/upi-vsphere-installation-reqs.html
https://115240--ocpdocs-pr.netlify.app/openshift-enterprise/latest/storage/container_storage_interface/persistent-storage-csi-vsphere.html

[openshift-ci]

@maxwelldb: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[openshift-ci-robot]

@maxwelldb: No Jira issue is referenced in the title of this pull request.
To reference a jira issue, add 'XYZ-NNN:' to the title of this pull request and request another refresh with /jira refresh.

Details

In response to this:

What

CQA 2.0/2.1 pre-migration pass for installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc and its included modules, part of OSDOCS-17008 (vSphere IPI, under epic OSDOCS-16987 / INSTALL-6).

Changes

• Added missing [role="_abstract"] short descriptions to the assembly and its included REFERENCE/CONCEPT modules.
• Stripped prose from the assembly's existing Additional resources block down to bare xrefs, clearing RelatedLinks.
• modules/installation-vsphere-installer-infra-requirements.adoc (the bulk of this PR):
• Unwrapped all 7 [%collapsible] blocks around the vCenter privilege tables. DITA/docs.rh doesn't support collapsible blocks, so per CQA-pass-criteria.md's ExampleBlock guidance, the wrapper is removed and the table content kept as is.
• Converted all [%hardbreaks] table cells listing multiple privileges into bullet lists (DITA doesn't support forced line breaks). Cells with only one item just had the now-unused [%hardbreaks] attribute removed. Verified the converted item count (332 bulleted + 9 single-item = 341) matches the original 341 backtick-quoted privileges exactly, so nothing was dropped.
• Promoted the two === subsections ("Required IP addresses", "DNS records") to == to clear NestedSection — DITA doesn't support === headings at all.
• modules/installation-vsphere-installer-infra-static-ip-nodes.adoc:
• Added the module's missing top-level = title — it previously started directly at ==, tripping DocumentTitle.
• Converted the <1>-<4> CalloutList callouts on the install-config.yaml sample into a where: definition list, ordered by first appearance in the code block, per the callout-conversion rules in CQA-pass-criteria.md.

Deliberately left as is

A pre-existing content typo (`VApp.Import`minimum`) in installation-vsphere-installer-infra-requirements.adoc is unrelated to Vale/DITA and out of scope for this CQA pass — flagging separately, not fixing here.

Verification

• vale --config=.vale-test.ini (AsciiDocDITA package) is clean, aside from the known NoXrefInModules false positive on the properly-formed Additional resources block.
• Rendered the assembly with asciidoctor -d book; the only remaining render error (installation-vsphere-installer-network-requirements.adoc incomplete table row) is pre-existing and unrelated to this change (confirmed by rendering the unmodified file from main).
• Rendered the static-IP module standalone and grepped <dt class="hdlist1"> to confirm all 4 where: terms render.

No technical/content meaning changed; this is a structural CQA pass only.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.