Skip to content

AAP-39131 - Created the assembly first. (#5950)#5960

Open
KylaF8 wants to merge 1 commit intoansible:2.5from
KylaF8:backport-2.5-5950
Open

AAP-39131 - Created the assembly first. (#5950)#5960
KylaF8 wants to merge 1 commit intoansible:2.5from
KylaF8:backport-2.5-5950

Conversation

@KylaF8
Copy link
Copy Markdown
Contributor

@KylaF8 KylaF8 commented Apr 29, 2026

AAP-39131 - https://redhat.atlassian.net/browse/AAP-39131

  • Created the assembly first.

  • Completed the Reference Module and the Procedure Module.

* Created the assembly first.

* Completed the Reference Module and the Procedure Module.
@KylaF8 KylaF8 added documentation Improvements or additions to documentation 2.5 Content applies to AAP 2.5 AAP operator Backported to 2.5 Changes have been applied to the AAP 2.5 branch labels Apr 29, 2026
Copy link
Copy Markdown
Contributor

@jklech-work jklech-work left a comment

Choose a reason for hiding this comment

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

Peer Review — AAP-39131

Nice work on the structure — assembly, reference, and procedure are well-organized with proper context handling and good use of product attributes.

Must fix

  1. Assembly not included in any guide's master.adoc — These 3 files are added but no master.adoc is updated with an include:: directive. The content won't appear in any published guide until it's wired in. Which guide should this go in — operator backup/restore?

  2. Wrong source language tag on YAML contentproc-configure-backup-compression.adoc line 21: [source,bash] should be [source,yaml] since the block contains a Kubernetes custom resource definition, not a shell script.

  3. Wrong source language tag on terminal commandsproc-configure-backup-compression.adoc lines 41, 48, 57: [source,bash] on oc commands should be [source,terminal] or omit the language tag entirely. Red Hat SSG: never use "bash" for terminal command examples.

Should fix

  1. Missing trailing newlineassembly-aap-backup-database-compression-for-operator-based-deployments.adoc line 22 and ref-backup-compression-configuration-parameters.adoc line 36: files end without a final newline. Most editors and linters expect one.

  2. User-replaced values need formattingproc-configure-backup-compression.adoc line 43: <backup_cr_file> and line 59: <backup_name> should use italic formatting for user-replaced values per Red Hat SSG (e.g., _<backup_cr_file>_).

  3. Boolean capitalizationref-backup-compression-configuration-parameters.adoc line 17: Default value shown as True (Python-style). Kubernetes CRDs typically use lowercase true. Worth verifying against the actual operator CRD spec.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2.5 Content applies to AAP 2.5 AAP operator Backported to 2.5 Changes have been applied to the AAP 2.5 branch documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants