[RHACS] [Docs] [rhacs-docs-main] ROX-33164: Fixing DITA errors in cloud_service/upgrading-cloud/upgrade-cloudsvc-helm.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]

🤖 Fri May 22 10:48:34 - Prow CI generated the docs preview:

https://112137--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-helm.html
https://112137--ocpdocs-pr.netlify.app/openshift-acs/latest/upgrading/upgrade-helm.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 a minor DITA compliance issue in the cloud service Helm upgrade documentation. The change corrects an Asciidoc syntax error in a module reference.

Scope: 1 file modified (1 module)

• DITA compliance: Attribute reference syntax correction
• Line count: +1 line added, -1 line removed

Summary of Changes

File	Location	Changes	Before/After
modules/upgrade-helm-chart.adoc	Procedure module	Fixed attribute reference syntax from {$product-title} to {product-title-short}	1 line modified

Key change:

• Corrected invalid attribute reference that included $ symbol (shell variable syntax)
• Replaced with proper Asciidoc attribute reference without $ prefix
• Changed to use product-title-short attribute for consistency

Navigation Guide - Review Changes

Step 1: Review Helm Upgrade Procedure

• Open: Upgrade using Helm
• Verify: Product title renders correctly in step content
• Check: No attribute placeholder text visible (like {product-title-short})

Step 2: Verify Attribute Resolution

• Location: Within upgrade procedure steps
• Verify: Product name appears as expected text (e.g., "RHACS" or full product name)
• Check: No broken attribute references or rendering issues

Verification Checklists

Structural Verification

• Asciidoc attribute syntax is correct
• Attribute reference resolves properly
• No unintended attribute changes

Content Verification

• Product title displays correctly
• Step content remains technically accurate
• No impact to procedure clarity

DITA Compliance Verification

• Attribute reference follows Asciidoc standards
• Syntax compatible with DITA conversion toolchain
• No shell variable syntax (e.g., $) in attributes

Quick Visual Review Guide

Key elements to check in Netlify preview:

1. Attribute rendering: Product title appears as text, not attribute placeholder
2. Content accuracy: Procedure steps reference correct product name
3. No errors: No visible parsing errors or malformed content

[jlprevatt]

LGTM

[agantony]

/cherrypick rhacs-docs-4.11

[agantony]

/cherrypick rhacs-docs-4.10

[openshift-cherrypick-robot]

@agantony: new pull request created: #119028

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

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.