Skip to content

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

Open
maxwelldb wants to merge 1 commit into
openshift:mainfrom
maxwelldb:vsphere-ipi-installer-provisioned-cqa-osdocs17008
Open

[OSDOCS-17008] CQA 2.1 for vSphere IPI installer-provisioned#115236
maxwelldb wants to merge 1 commit into
openshift:mainfrom
maxwelldb:vsphere-ipi-installer-provisioned-cqa-osdocs17008

Conversation

@maxwelldb

@maxwelldb maxwelldb commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

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 base installer-provisioned assembly.

…sembly

Add missing [role="_abstract"] short description to the assembly, and
extract the "Creating registry storage" heading and intro sentence
into a new REFERENCE module to clear the AssemblyContents Vale hit
that content between includes triggers. Move the registry-storage and
remote-health-monitoring cross references out of assembly-body prose
into module-level Additional resources blocks, clearing ConceptLink
and RelatedLinks hits.

The Prerequisites and Next steps sections' embedded xrefs are left as
is, matching the AWS/GCP/Nutanix precedent of deferring that
structural pattern epic-wide (see CQA-pass-criteria.md). The
pre-existing ConceptLink hit on modules/cluster-entitlements.adoc is
also left as is, matching a prior CQA commit that already fixed this
shared module's ShortDescription but intentionally left that link.
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 13, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 13, 2026

Copy link
Copy Markdown

@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.adoc and its included modules, part of OSDOCS-17008 (vSphere IPI, under epic OSDOCS-16987 / INSTALL-6).

Changes

  • Added missing [role="_abstract"] short description to the assembly's intro paragraph.
  • Extracted the "Creating registry storage" heading and its intro sentence — previously sitting directly in the assembly body between module includes — into a new modules/installing-vsphere-installer-provisioned-registry-reference.adoc REFERENCE module, 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 hits.

Deliberately left as is (matches epic-wide precedent)

  • The Prerequisites and Next steps sections' embedded xrefs are unchanged. This copy-pasted structural pattern (a heading with prose/xrefs directly in the assembly body, rather than a proper Additional resources block) is confirmed present and unresolved on the AWS, GCP, and Nutanix installer-provisioned assemblies too — see CQA-pass-criteria.md's "Before touching a widespread pattern" guidance. Fixing it here would be a bigger, more content-altering change than the rest of this CQA pass and would make vSphere diverge from its siblings.
  • modules/cluster-entitlements.adoc's link:http://quay.io[Quay.io] ConceptLink hit is left as is — a prior CQA commit (c79a79c276793855e186f70184bbd83ae0cb93d3, OSDOCS-17013) already fixed this shared module's ShortDescription but intentionally left this link, so this PR matches that precedent rather than diverging.

Verification

  • vale --config=.vale-test.ini (AsciiDocDITA package) shows only the deferred hits above and one known NoXrefInModules false positive on the new, properly-formed Additional resources blocks.
  • Rendered with asciidoctor -d book to confirm heading structure and TOC nesting are unchanged.

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 openshift-ci Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 13, 2026
@ocpdocs-previewbot

Copy link
Copy Markdown

@openshift-ci

openshift-ci Bot commented Jul 13, 2026

Copy link
Copy Markdown

@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.

@maxwelldb maxwelldb changed the title OSDOCS-17008: CQA 2.1 for vSphere IPI - installer-provisioned base assembly [OSDOCS#17008] CQA 2.1 for vSphere IPI - installer-provisioned base assembly Jul 13, 2026
@openshift-ci-robot openshift-ci-robot removed the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 13, 2026
@openshift-ci-robot

Copy link
Copy Markdown

@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.adoc and its included modules, part of OSDOCS-17008 (vSphere IPI, under epic OSDOCS-16987 / INSTALL-6).

Changes

  • Added missing [role="_abstract"] short description to the assembly's intro paragraph.
  • Extracted the "Creating registry storage" heading and its intro sentence — previously sitting directly in the assembly body between module includes — into a new modules/installing-vsphere-installer-provisioned-registry-reference.adoc REFERENCE module, 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 hits.

Deliberately left as is (matches epic-wide precedent)

  • The Prerequisites and Next steps sections' embedded xrefs are unchanged. This copy-pasted structural pattern (a heading with prose/xrefs directly in the assembly body, rather than a proper Additional resources block) is confirmed present and unresolved on the AWS, GCP, and Nutanix installer-provisioned assemblies too — see CQA-pass-criteria.md's "Before touching a widespread pattern" guidance. Fixing it here would be a bigger, more content-altering change than the rest of this CQA pass and would make vSphere diverge from its siblings.
  • modules/cluster-entitlements.adoc's link:http://quay.io[Quay.io] ConceptLink hit is left as is — a prior CQA commit (c79a79c276793855e186f70184bbd83ae0cb93d3, OSDOCS-17013) already fixed this shared module's ShortDescription but intentionally left this link, so this PR matches that precedent rather than diverging.

Verification

  • vale --config=.vale-test.ini (AsciiDocDITA package) shows only the deferred hits above and one known NoXrefInModules false positive on the new, properly-formed Additional resources blocks.
  • Rendered with asciidoctor -d book to confirm heading structure and TOC nesting are unchanged.

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.

@maxwelldb maxwelldb changed the title [OSDOCS#17008] CQA 2.1 for vSphere IPI - installer-provisioned base assembly [OSDOCS-17008] CQA 2.1 for vSphere IPI installer-provisioned Jul 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants