Skip to content

OSDOCS-16950#CQA work Stor6 - LVMS installation - #116568

Merged
lpettyjo merged 1 commit into
openshift:mainfrom
lpettyjo:OSDOCS-16950-lvms-install
Aug 5, 2026
Merged

OSDOCS-16950#CQA work Stor6 - LVMS installation#116568
lpettyjo merged 1 commit into
openshift:mainfrom
lpettyjo:OSDOCS-16950-lvms-install

Conversation

@lpettyjo

@lpettyjo lpettyjo commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Split from #115159. CQA updates for LVMS installation modules.

https://issues.redhat.com/browse/OSDOCS-16950

Dear reviewer, please check the assembly file as well (#116579).

@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 27, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 27, 2026

Copy link
Copy Markdown

@cbippley

Copy link
Copy Markdown
Contributor

/label merge-review-in-progress

@cbippley cbippley added this to the Continuous Release milestone Jul 29, 2026
@openshift-ci openshift-ci Bot added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Jul 29, 2026
@cbippley

cbippley commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Review Guide — OSDOCS-16950 LVMS Installation CQA

Summary: CQA improvements across 8 LVMS installation files — adds [role="_abstract"] tags, replaces numbered callouts with definition lists, improves short descriptions, removes extra blank lines, and standardizes cross-references.

Changes at a Glance

Change Type Count Details
Added [role="_abstract"] 5 modules About, disconnected, CLI, web console, RHACM install
Callouts → definition lists 2 files lvms-creating-lvmcluster, lvms-disconnected-ImageSetConfig
Short description rewrites 5 modules More actionable, task-oriented language
Hardcoded "OpenShift" → {product-title} 1 module external-auth-disabling replaced with attribute
RHACM callout removal 1 module Removed numbered callouts <1><4>, replaced with bullet list
Formatting cleanup 4 files Removed extra blank lines before .Prerequisites/.Procedure

Step-by-Step Visual Review

All changes render on a single page. Open the base URL, then use anchors to jump to each section:

Base URL: persistent-storage-using-lvms.html

# Section What to Check Preview Link
1 About LVMS installation Abstract tag renders, updated cross-ref text About
2 Install via CLI Abstract renders, no extra whitespace CLI install
3 Install via web console Abstract renders, .Verification label (not .Verification steps) Web console
4 Install via RHACM Abstract renders, callouts replaced with bullet list, YAML clean RHACM
5 Disconnected install Abstract renders, cross-ref text cleaned up, no "section" suffix Disconnected
6 Creating LVMCluster (snippet) Callouts replaced with trailing sentence listing optional fields LVMCluster CR
7 ImageSetConfiguration (snippet) Callouts replaced with definition list, all 9 fields described ImageSetConfig
8 Static mode enforcement Reworded abstract, no content loss Static mode

Quick Checklist

  • All [role="_abstract"] sections render correctly (no raw markup visible)
  • Callout replacements in RHACM YAML display as a clean bullet list
  • ImageSetConfiguration snippet shows definition list instead of numbered callouts
  • LVMCluster snippet trailing sentence renders (not raw AsciiDoc)
  • No broken cross-references or missing content
  • Formatting is consistent (no extra blank lines between sections)

@cbippley cbippley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some blockers found, fix and merge.

Comment thread modules/lvms-installing-logical-volume-manager-operator-using-rhacm.adoc Outdated
Comment thread modules/lvms-installing-logical-volume-manager-operator-using-rhacm.adoc Outdated
Comment thread modules/lvms-installing-logical-volume-manager-operator-using-rhacm.adoc Outdated
Comment thread modules/lvms-installing-logical-volume-manager-operator-using-rhacm.adoc Outdated
Comment thread modules/lvms-installing-logical-volume-manager-operator-using-rhacm.adoc Outdated
Comment thread snippets/lvms-disconnected-ImageSetConfig.adoc Outdated
Comment thread snippets/lvms-disconnected-ImageSetConfig.adoc Outdated
Comment thread snippets/lvms-disconnected-ImageSetConfig.adoc Outdated
Comment thread snippets/lvms-creating-lvmcluster.adoc Outdated
Comment thread modules/static-mode-enforcement.adoc Outdated
@lpettyjo
lpettyjo force-pushed the OSDOCS-16950-lvms-install branch from 8c2dcf8 to e7093b8 Compare August 5, 2026 12:24
@lpettyjo lpettyjo added ok-to-merge and removed merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR labels Aug 5, 2026
@lpettyjo
lpettyjo force-pushed the OSDOCS-16950-lvms-install branch from e7093b8 to 3148319 Compare August 5, 2026 16:48
@openshift-ci

openshift-ci Bot commented Aug 5, 2026

Copy link
Copy Markdown

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

@lpettyjo
lpettyjo merged commit dfb27fc into openshift:main Aug 5, 2026
2 checks passed
@lpettyjo

lpettyjo commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-5.0

@lpettyjo

lpettyjo commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.22

@openshift-cherrypick-robot

Copy link
Copy Markdown

@lpettyjo: new pull request created: #117399

Details

In response to this:

/cherrypick enterprise-5.0

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.

@openshift-cherrypick-robot

Copy link
Copy Markdown

@lpettyjo: new pull request created: #117400

Details

In response to this:

/cherrypick enterprise-4.22

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.

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.

4 participants