Skip to content

[OSDOCS-17003] IBM Z CQA work#116100

Open
SNiemann15 wants to merge 1 commit into
openshift:mainfrom
SNiemann15:ibmz_cqa_work
Open

[OSDOCS-17003] IBM Z CQA work#116100
SNiemann15 wants to merge 1 commit into
openshift:mainfrom
SNiemann15:ibmz_cqa_work

Conversation

@SNiemann15

@SNiemann15 SNiemann15 commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Version(s):

Issue: https://redhat.atlassian.net/browse/OSDOCS-17003

Link to docs preview: https://116100--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_ibm_z/preparing-to-install-on-ibm-z

QE review:

  • QE has approved this change.

Additional information:

Content Quality Audit (CQA): IBM Z and LinuxONE installation documentation

This PR applies a full content quality audit to the IBM Z and LinuxONE installation modules and assemblies in installing/installing_ibm_z/ and installing/installing_ibm_z/upi/ in preparation for DITA migration.

Modules

  • Added [role="_abstract"] short descriptions to all modules
  • Fixed IBM Style and Red Hat Supplementary Style Guide violations (passive voice, term casing, punctuation)
  • Fixed BlockTitle violations flagged by the AsciiDocDITA Vale ruleset
  • Removed xref: macros from all REFERENCE modules (moved to consuming assemblies per NoXrefInModules)
  • Extracted the == RoCE network cards section into a standalone module (ibm-z-roce-network-cards.adoc)
  • Created four new REFERENCE prerequisite modules extracted from assembly inline content: prereqs-ibm-z-upi.adoc, prereqs-ibm-z-upi-disconnected.adoc, prereqs-ibm-z-kvm-upi.adoc, prereqs-ibm-z-kvm-upi-disconnected.adoc

Assemblies

  • Added [role="_abstract"] to all assemblies
  • Anchored all assembly-level == Additional resources sections with [role="_additional-resources"] and [id=] attributes
  • Converted intermediate .Additional resources blocks between include:: directives from == section titles to block title syntax to resolve AsciiDoc section-title-out-of-sequence warnings
  • Replaced inline Prerequisites sections with include:: directives pointing to the new prerequisite modules
  • Added .Additional resources blocks in assemblies to carry xrefs relocated from modules
  • Moved == Next steps content into the final == Additional resources section in all UPI assemblies

@openshift-ci openshift-ci Bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jul 22, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 22, 2026

Copy link
Copy Markdown

🤖 Fri Jul 24 10:30:42 - Prow CI generated the docs preview:
https://116100--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

Comment thread modules/prereqs-ibm-z-kvm-upi-disconnected.adoc Outdated
Comment thread modules/prereqs-ibm-z-kvm-upi-disconnected.adoc Outdated
Comment thread modules/prereqs-ibm-z-kvm-upi-disconnected.adoc Outdated
Comment thread modules/prereqs-ibm-z-kvm-upi-disconnected.adoc Outdated
Comment thread modules/prereqs-ibm-z-kvm-upi-disconnected.adoc Outdated
Comment thread modules/prereqs-ibm-z-kvm-upi-disconnected.adoc Outdated
Comment thread modules/prereqs-ibm-z-kvm-upi.adoc Outdated
Comment thread modules/prereqs-ibm-z-kvm-upi.adoc Outdated
Comment thread modules/prereqs-ibm-z-kvm-upi.adoc Outdated
Comment thread modules/prereqs-ibm-z-kvm-upi.adoc Outdated
Comment thread modules/prereqs-ibm-z-kvm-upi.adoc Outdated
Comment thread modules/prereqs-ibm-z-upi-disconnected.adoc Outdated
Comment thread modules/prereqs-ibm-z-upi-disconnected.adoc Outdated
Comment thread modules/prereqs-ibm-z-upi-disconnected.adoc Outdated
Comment thread modules/prereqs-ibm-z-upi-disconnected.adoc Outdated
Comment thread modules/prereqs-ibm-z-upi-disconnected.adoc Outdated
Comment thread modules/prereqs-ibm-z-upi-disconnected.adoc Outdated
Comment thread modules/prereqs-ibm-z-upi.adoc Outdated
Comment thread modules/prereqs-ibm-z-upi.adoc Outdated
Comment thread modules/prereqs-ibm-z-upi.adoc Outdated
Comment thread modules/prereqs-ibm-z-upi.adoc Outdated
Comment thread modules/prereqs-ibm-z-upi.adoc Outdated
@SNiemann15

SNiemann15 commented Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

Separate callout-replacement changes from general CQA improvements.
The callout replacements for the following modules have been moved to
the ibmz_cqa_callout_replacement PR: #116250

  • modules/ibm-z-configure-devices-mco.adoc
  • modules/ibm-z-configure-hw-based-cex-encryption.adoc
  • modules/ibm-z-configure-nbde-with-static-ip.adoc
  • modules/installation-full-ibm-z-kvm-user-infra-machines-iso.adoc
  • modules/installation-ibm-z-kvm-user-infra-machines-iso.adoc
  • modules/installation-ibm-z-user-infra-machines-iso.adoc

All other CQA changes in these modules (role abstracts, title fixes,
structural improvements, conditional cleanup) are retained here." 2>&1

@openshift-ci openshift-ci Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 23, 2026
@openshift-ci openshift-ci Bot removed the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 24, 2026
@openshift-ci openshift-ci Bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jul 24, 2026
@openshift-ci openshift-ci Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 24, 2026
@openshift-ci

openshift-ci Bot commented Jul 24, 2026

Copy link
Copy Markdown

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants