Skip to content

OSDOCS-16950#CQA work Stor6 - LVMS LVMCluster CR - #116573

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

OSDOCS-16950#CQA work Stor6 - LVMS LVMCluster CR#116573
lpettyjo merged 1 commit into
openshift:mainfrom
lpettyjo:OSDOCS-16950-lvms-lvmcluster

Conversation

@lpettyjo

@lpettyjo lpettyjo commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Split from #115159. CQA updates for LVMS LVMCluster CR, creating, and deleting modules.

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

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

@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 27, 2026

Copy link
Copy Markdown

@lpettyjo lpettyjo added the merge-review-needed Signifies that the merge review team needs to review this PR label Jul 27, 2026
@cbippley

Copy link
Copy Markdown
Contributor

/label merge-review-in-progress
/remove-label merge-review-needed

@openshift-ci openshift-ci Bot added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Jul 29, 2026
@cbippley

cbippley commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Review Guide — OSDOCS-16950 CQA: LVMS LVMCluster CR

Preview base: persistent-storage-using-lvms.html

Summary of changes (14 files)

Category What changed
Abstract blocks Added [role="_abstract"] with action-oriented intro sentences to 10 modules
Callout → definition list Replaced numbered callouts (<1>, <2>, …) with inline * spec.field: definition-list format across 6 files
External links Converted bare link:https://...[] references to plain-text titles (RHEL docs for RAID, LVM tags, persistent naming)
Whitespace / formatting Removed blank lines after .Prerequisites, .Procedure, .Verification headings; fixed "failue" → "failure" typo
Section ID added New [id="about-lvmcluster-exaplain-fields_{context}"] on "Explanation of fields" subsection
Optional → required steps Two verification steps changed from "Optional:" to required in CLI create module
Reuse VG verification Converted [NOTE] block into a proper .Verification section

Quick visual review checklist

Click each link → scan for correct rendering → check no broken formatting.

# Section Preview link
1 About the LVMCluster CR View
2 Explanation of fields table View
3 Ways to create an LVMCluster CR View
4 Creating LVMCluster by CLI View
5 Creating LVMCluster by web console View
6 Creating LVMCluster by RHACM View
7 About adding devices to a VG View
8 About removing devices from VG View
9 Devices not supported by LVMS View
10 Reusing a VG from previous install View
11 Ways to delete an LVMCluster CR View
12 Deleting LVMCluster by CLI View
13 Deleting LVMCluster by web console View
14 Deleting LVMCluster by RHACM View
15 Deleting an LVM cluster (gate) View

What to look for

  • Abstract text renders correctly (not raw [role="_abstract"])
  • Definition lists (* spec.field:) display properly — no stray asterisks or broken formatting
  • External link text appears as plain titles (no bare URLs visible)
  • Code blocks still have correct syntax highlighting
  • No orphaned callout numbers (<1>, <2>, etc.) remain
  • Verification sections render with proper heading structure
  • New section ID about-lvmcluster-exaplain-fields anchor works

@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 nits to fix before merging.

Comment thread modules/lvms-about-adding-devices-to-a-vg.adoc Outdated
Comment thread modules/lvms-about-adding-devices-to-a-vg.adoc Outdated
Comment thread modules/lvms-about-creating-lvmcluster-cr.adoc Outdated
Comment thread modules/lvms-about-deleting-lvmcluster-cr.adoc Outdated
Comment thread modules/lvms-about-lvmcluster-cr.adoc Outdated
Comment thread modules/lvms-deleting-lvmcluster-using-rhacm.adoc Outdated
Comment thread modules/lvms-deleting-lvmcluster-using-rhacm.adoc Outdated
Comment thread modules/lvms-deleting-lvmcluster-using-web-console.adoc Outdated
Comment thread modules/lvms-reusing-vg-from-prev-installation.adoc Outdated
Comment thread modules/lvms-reusing-vg-from-prev-installation.adoc
@cbippley cbippley added this to the Continuous Release milestone Jul 29, 2026
@cbippley

Copy link
Copy Markdown
Contributor

/remove-label merge-review-in-progress

@openshift-ci openshift-ci Bot removed the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Jul 29, 2026
@lpettyjo
lpettyjo force-pushed the OSDOCS-16950-lvms-lvmcluster branch from 4bcd50d to ae792a6 Compare August 4, 2026 23:32
@openshift-ci

openshift-ci Bot commented Aug 4, 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 55e9bc7 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: #117397

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: #117398

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