[OSDOCS#17008] CQA 2.1 for vSphere IPI installer-provisioned with customizations

[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 installer-provisioned-with-customizations assembly.

[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/installing-vsphere-installer-provisioned-customizations.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 CONCEPT/PROCEDURE modules (installation-vsphere-regions-zones.adoc, installation-vsphere-regions-zones-host-groups.adoc, ipi-install-modifying-install-config-for-dual-stack-network.adoc, configuring-vsphere-regions-zones.adoc, configuring-vsphere-host-groups.adoc, installation-vsphere-multiple-nics.adoc, nw-operator-vsphere-multiple-subnets.adoc, ipi-install-configure-network-components-to-run-on-the-control-plane.adoc).
• Extracted the "Creating registry storage" heading and its intro sentence into a new modules/installing-vsphere-installer-provisioned-customizations-registry-reference.adoc REFERENCE module — same fix already applied to the base installer-provisioned assembly (PR #115236) — clearing the AssemblyContents hit.
• Moved the "Configuring the registry for vSphere" and "About remote health monitoring" cross references out of prose sentences into proper module-level .Additional resources blocks, clearing ConceptLink/RelatedLinks.
• modules/installation-vsphere-multiple-nics.adoc:
• Converted the single <1> callout on the networks: field into a plain +-attached continuation sentence rather than a where: list, since there's only one callout — per the single-callout rule in CQA-pass-criteria.md. Clears CalloutList.
• Removed a stray extra + between each .Example configuration title and its following [source,yaml] block. The extra + broke the title-to-block association, so the rule flagged these as orphaned even though they're valid code captions. Clears BlockTitle.

Deliberately left as is (matches epic-wide precedent)

• The Prerequisites and Next steps sections' embedded xrefs are unchanged, matching the AWS/GCP/Nutanix precedent documented in CQA-pass-criteria.md.
• modules/cluster-entitlements.adoc's link:http://quay.io[Quay.io] ConceptLink hit is left as is, matching the prior CQA commit that already fixed this shared module's ShortDescription but intentionally left this link (same precedent applied in PR #115236).

Verification

• vale --config=.vale-test.ini (AsciiDocDITA package) shows only the deferred hits above and known NoXrefInModules false positives on the properly-formed Additional resources blocks.
• Rendered with asciidoctor -d book — clean, no structural errors, only pre-existing image-asset warnings.
• Confirmed the callout conversion and block-title fixes render correctly (continuation sentence and .Example configuration captions both render as expected).

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.

[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/installing-vsphere-installer-provisioned-customizations.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 CONCEPT/PROCEDURE modules (installation-vsphere-regions-zones.adoc, installation-vsphere-regions-zones-host-groups.adoc, ipi-install-modifying-install-config-for-dual-stack-network.adoc, configuring-vsphere-regions-zones.adoc, configuring-vsphere-host-groups.adoc, installation-vsphere-multiple-nics.adoc, nw-operator-vsphere-multiple-subnets.adoc, ipi-install-configure-network-components-to-run-on-the-control-plane.adoc).
• Extracted the "Creating registry storage" heading and its intro sentence into a new modules/installing-vsphere-installer-provisioned-customizations-registry-reference.adoc REFERENCE module — same fix already applied to the base installer-provisioned assembly (PR #115236) — clearing the AssemblyContents hit.
• Moved the "Configuring the registry for vSphere" and "About remote health monitoring" cross references out of prose sentences into proper module-level .Additional resources blocks, clearing ConceptLink/RelatedLinks.
• modules/installation-vsphere-multiple-nics.adoc:
• Converted the single <1> callout on the networks: field into a plain +-attached continuation sentence rather than a where: list, since there's only one callout — per the single-callout rule in CQA-pass-criteria.md. Clears CalloutList.
• Removed a stray extra + between each .Example configuration title and its following [source,yaml] block. The extra + broke the title-to-block association, so the rule flagged these as orphaned even though they're valid code captions. Clears BlockTitle.

Deliberately left as is (matches epic-wide precedent)

• The Prerequisites and Next steps sections' embedded xrefs are unchanged, matching the AWS/GCP/Nutanix precedent documented in CQA-pass-criteria.md.
• modules/cluster-entitlements.adoc's link:http://quay.io[Quay.io] ConceptLink hit is left as is, matching the prior CQA commit that already fixed this shared module's ShortDescription but intentionally left this link (same precedent applied in PR #115236).

Verification

• vale --config=.vale-test.ini (AsciiDocDITA package) shows only the deferred hits above and known NoXrefInModules false positives on the properly-formed Additional resources blocks.
• Rendered with asciidoctor -d book — clean, no structural errors, only pre-existing image-asset warnings.
• Confirmed the callout conversion and block-title fixes render correctly (continuation sentence and .Example configuration captions both render as expected).

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 19:22:35 - Prow CI generated the docs preview:

https://115242--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_bare_metal/ipi/ipi-install-installation-workflow.html
https://115242--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.html
https://115242--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.html
https://115242--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_vsphere/upi/installing-restricted-networks-vsphere.html
https://115242--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_vsphere/upi/installing-vsphere.html
https://115242--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_vsphere/upi/installing-vsphere-network-customizations.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.