[RHACS] [Docs] [rhacs-docs-main] ROX-33164: Fixing DITA errors in cloud_service/upgrading-cloud/upgrade-cloudsvc-operator.adoc

[agantony]

Version(s):
4.9+

Issue:
https://redhat.atlassian.net/browse/ROX-33164

Link to docs preview:

SME review: NA

Additional information:

• Cherrypick to:
  • rhacs-docs-4.10
  • rhacs-docs-4.9

[openshift-ci-robot]

@agantony: This pull request references ROX-33164 which is a valid jira issue.

Details

In response to this:

Version(s):
4.9+

Issue:
https://redhat.atlassian.net/browse/ROX-33164

Link to docs preview:

SME review: NA

Additional information:

• Cherrypick to:
  • rhacs-docs-4.10
  • rhacs-docs-4.9

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]

🤖 Sun May 24 13:31:07 - Prow CI generated the docs preview:

https://112144--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-operator.html
https://112144--ocpdocs-pr.netlify.app/openshift-acs/latest/upgrading/upgrade-operator.html

[openshift-ci]

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

[agantony]

PR Review Summary

Changes Made

This PR addresses DITA compliance issues in the cloud service operator upgrade documentation. The changes extract rollback procedure content into a dedicated module and reorganize the assembly structure.

Scope: 3 files modified (1 assembly, 2 modules)

• Content restructuring: Rollback procedure extraction
• DITA compliance: Module organization and procedure separation
• Line count: +23 lines added, -14 lines removed

Summary of Changes

File	Location	Changes	Before/After
cloud_service/upgrading-cloud/upgrade-cloudsvc-operator.adoc	Assembly file	Reorganized module includes, updated structure	7 lines added, 14 lines removed
modules/rollback-operator-upgrade-cloud.adoc	Procedure module (new)	New module for operator upgrade rollback procedure	15 lines added
modules/operator-upgrade-troubleshooting.adoc	Reference module	Added missing line break	1 line added

Key structural changes:

• Extracted operator upgrade rollback into dedicated procedure module
• Reorganized assembly to present upgrade and rollback workflows clearly
• Updated module includes for improved modularity

Navigation Guide - Review Changes

Step 1: Review Main Assembly Structure

• Open: Upgrade using Operator
• Verify: Document flows from upgrade procedure → rollback procedure → troubleshooting
• Check: All sections render correctly with proper hierarchy

Step 2: Verify Operator Upgrade Procedure

• Location: Main upgrade content in assembly
• Verify: Operator upgrade steps are clear and complete
• Check: OpenShift OperatorHub instructions are accurate

Step 3: Verify Rollback Procedure

• Location: Included procedure module
• Verify: Rollback steps are clear and actionable
• Check: Rollback prerequisites and warnings are present

Step 4: Verify Troubleshooting Section

• Location: Included reference module
• Verify: Troubleshooting guidance is complete
• Check: Common issues and resolutions are documented

Verification Checklists

Structural Verification

• Assembly includes modules in logical workflow order
• New rollback module follows DITA naming conventions
• Module types align with content (PROCEDURE vs REFERENCE)
• Include statements use correct file paths

Content Verification

• Operator upgrade steps remain complete
• Rollback procedure provides clear recovery steps
• Troubleshooting content is accessible
• No upgrade or rollback content lost during reorganization

DITA Compliance Verification

• Rollback extracted into reusable procedure module
• Assembly focuses on workflow organization
• Content enables reuse across operator upgrade scenarios
• Asciidoc syntax supports DITA conversion

Quick Visual Review Guide

Key elements to check in Netlify preview:

1. Workflow clarity: Upgrade → Rollback → Troubleshooting progression is clear
2. Procedure formatting: Steps are numbered and sequential
3. Warnings/cautions: Important notices render prominently
4. Content completeness: All original upgrade and rollback content is present
5. Cross-references: Links to related procedures work correctly

[jlprevatt]

LGTM

[agantony]

/cherrypick rhacs-docs-4.11

[agantony]

/cherrypick rhacs-docs-4.10

[openshift-cherrypick-robot]

@agantony: new pull request created: #119030

Details

In response to this:

/cherrypick rhacs-docs-4.11

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]

@agantony: new pull request created: #119031

Details

In response to this:

/cherrypick rhacs-docs-4.10

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.