[RHACS] [Docs] [rhacs-docs-main] ROX-33164: Fixing DITA errors in cloud_service/acscs-default-requirements.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):

Issue:

Link to docs preview:

QE review:

• QE has approved this change.

Additional information:

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]

🤖 Fri May 22 09:53:27 - Prow CI generated the docs preview:

https://112135--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/acscs-default-requirements.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 default requirements documentation. The changes reorganize content into properly structured modules following DITA best practices, extracting system and Helm requirements into separate procedure modules.

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

• Content restructuring: Modular content extraction
• DITA compliance: Module type validation and structural improvements
• Line count: +87 lines added, -52 lines removed

Summary of Changes

File	Location	Changes	Before/After
cloud_service/acscs-default-requirements.adoc	Assembly file	Reorganized content includes, added new module references	15 lines added
modules/acs-cloud-requirements.adoc	Concept module	Removed system requirements content (moved to separate module)	52 lines removed
modules/acscs-helm-requirements.adoc	Procedure module (new)	New module for Helm requirements procedure	19 lines added
modules/acscs-system-requirements.adoc	Reference module (new)	New module containing system requirements reference table	52 lines added

Key structural changes:

• Extracted Helm installation requirements into dedicated procedure module
• Moved system requirements into standalone reference module
• Updated assembly to include new modular structure

Navigation Guide - Review Changes

Step 1: Review Assembly Structure

• Open: Default requirements assembly
• Verify: Module organization, content hierarchy, include statements
• Check: Section headings render correctly, no broken includes

Step 2: Verify System Requirements Module

• Location: Included in assembly as reference content
• Verify: System requirements table displays correctly
• Check: All minimum requirements are present and accurate

Step 3: Verify Helm Requirements Module

• Location: Included in assembly as procedure content
• Verify: Procedure steps are clear and actionable
• Check: Prerequisites are clearly stated

Verification Checklists

Structural Verification

• Assembly file includes correct module references
• New modules follow DITA naming conventions
• Module metadata (content type) is correct
• Include statements use correct file paths

Content Verification

• System requirements table is complete
• Helm installation steps are accurate
• No content duplication between modules
• All technical details preserved during reorganization

DITA Compliance Verification

• Module types align with content (CONCEPT, PROCEDURE, REFERENCE)
• Single responsibility per module maintained
• Content reusability enabled through modularization
• Asciidoc syntax follows DITA-compatible patterns

Quick Visual Review Guide

Key elements to check in Netlify preview:

1. Table rendering: System requirements table displays properly
2. Section hierarchy: Headings follow logical document structure
3. Content flow: Information progresses logically from overview to specifics
4. No missing sections: All original content appears in reorganized structure

[jlprevatt]

LGTM

[agantony]

/cherrypick rhacs-docs-4.11

[agantony]

/cherrypick rhacs-docs-4.10

[openshift-cherrypick-robot]

@agantony: #112135 failed to apply on top of branch "rhacs-docs-4.10":

Applying: ROX33164 Fixing DITA errors in cloud_service/acscs-default-requirements.adoc
Using index info to reconstruct a base tree...
M	cloud_service/acscs-default-requirements.adoc
Falling back to patching base and 3-way merge...
Auto-merging cloud_service/acscs-default-requirements.adoc
CONFLICT (content): Merge conflict in cloud_service/acscs-default-requirements.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 ROX33164 Fixing DITA errors in cloud_service/acscs-default-requirements.adoc

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.

[openshift-cherrypick-robot]

@agantony: new pull request created: #119027

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.