[OSDOCS-17008] CQA 2.1 for vSphere IPI restricted network installation

[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 restricted-network installation 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-restricted-networks-installer-provisioned-vsphere.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, configuring-vsphere-regions-zones.adoc, configuring-vsphere-host-groups.adoc, installation-creating-image-restricted.adoc, olm-restricted-networks-configuring-operatorhub.adoc).
• Extracted the "Creating registry storage" heading and its intro sentence into a new modules/installing-restricted-networks-installer-provisioned-vsphere-registry-reference.adoc REFERENCE module — same fix already applied to the other vSphere IPI assemblies in this epic (#115236, #115242) — clearing AssemblyContents.
• Stripped prose from the assembly's existing "About remote health monitoring" Additional resources item down to a bare xref, clearing RelatedLinks.
• modules/installation-creating-image-restricted.adoc: moved the post-procedure sentence ("The image is now available...") under a new .Results block instead of leaving it as floating prose after .Procedure, clearing TaskStep.
• modules/olm-restricted-networks-configuring-operatorhub.adoc: attached the [TIP] admonition to the preceding (and only) procedure step via + instead of leaving it floating in the module body, clearing TaskStep.

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 the other PRs in this epic).

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 .Results block and [TIP] attachment 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 18:46:50 - Prow CI generated the docs preview:
https://115243--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

[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/installing-restricted-networks-installer-provisioned-vsphere.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, configuring-vsphere-regions-zones.adoc, configuring-vsphere-host-groups.adoc, installation-creating-image-restricted.adoc, olm-restricted-networks-configuring-operatorhub.adoc).
• Extracted the "Creating registry storage" heading and its intro sentence into a new modules/installing-restricted-networks-installer-provisioned-vsphere-registry-reference.adoc REFERENCE module — same fix already applied to the other vSphere IPI assemblies in this epic (#115236, #115242) — clearing AssemblyContents.
• Stripped prose from the assembly's existing "About remote health monitoring" Additional resources item down to a bare xref, clearing RelatedLinks.
• modules/installation-creating-image-restricted.adoc: moved the post-procedure sentence ("The image is now available...") under a new .Results block instead of leaving it as floating prose after .Procedure, clearing TaskStep.
• modules/olm-restricted-networks-configuring-operatorhub.adoc: attached the [TIP] admonition to the preceding (and only) procedure step via + instead of leaving it floating in the module body, clearing TaskStep.

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 the other PRs in this epic).

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 .Results block and [TIP] attachment 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.