AAP-39131 - Created the assembly first. (#5950)#5960
AAP-39131 - Created the assembly first. (#5950)#5960KylaF8 wants to merge 1 commit intoansible:2.5from
Conversation
* Created the assembly first. * Completed the Reference Module and the Procedure Module.
jklech-work
left a comment
There was a problem hiding this comment.
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
-
Assembly not included in any guide's master.adoc — These 3 files are added but no
master.adocis updated with aninclude::directive. The content won't appear in any published guide until it's wired in. Which guide should this go in — operator backup/restore? -
Wrong source language tag on YAML content —
proc-configure-backup-compression.adocline 21:[source,bash]should be[source,yaml]since the block contains a Kubernetes custom resource definition, not a shell script. -
Wrong source language tag on terminal commands —
proc-configure-backup-compression.adoclines 41, 48, 57:[source,bash]onoccommands should be[source,terminal]or omit the language tag entirely. Red Hat SSG: never use "bash" for terminal command examples.
Should fix
-
Missing trailing newline —
assembly-aap-backup-database-compression-for-operator-based-deployments.adocline 22 andref-backup-compression-configuration-parameters.adocline 36: files end without a final newline. Most editors and linters expect one. -
User-replaced values need formatting —
proc-configure-backup-compression.adocline 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>_). -
Boolean capitalization —
ref-backup-compression-configuration-parameters.adocline 17: Default value shown asTrue(Python-style). Kubernetes CRDs typically use lowercasetrue. Worth verifying against the actual operator CRD spec.
AAP-39131 - https://redhat.atlassian.net/browse/AAP-39131
Created the assembly first.
Completed the Reference Module and the Procedure Module.