Skip to content

Commit 3f458ac

Browse files
themr0cclaude
andcommitted
RHIDP-12779: Fix CQA script false positives and apply content fixes
Script fixes (eliminate false positives): - cqa-05: Allow .Example/.Sample block titles and descriptive labels in reference modules; broaden allowed procedure block titles - cqa-09: Resolve {abstract} attribute references before measuring length - cqa-12: Only report Vale errors as failures (not warnings/suggestions); show issue count instead of "(see output above)" - cqa-13: Remove assembly body content check (belongs to CQA #6) - cqa-14: Resolve images via :imagesdir: attribute; skip URLs/YAML - cqa-17: Skip Technology Preview mentions inside source blocks; accept inline mentions with official Red Hat support link Content fixes: - Shorten 9 too-long abstracts (auth, service-to-service, tokens) - Expand 1 too-short abstract (troubleshoot authentication) - Remove open block markers from 2 abstracts (guest user, s2s auth) - Fix 8 Vale TermsWarnings (click on→click, like→such as, etc.) - Fix .Procedure trailing space in sidebar menu localization - CQA autofix: parent-context preservation in nested assemblies Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 51ad2cd commit 3f458ac

69 files changed

Lines changed: 342 additions & 135 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

assemblies/configure_configuring-rhdh/assembly-configure-external-postgresql-databases.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
23

34
[id="configure-external-postgresql-databases_{context}"]
45
= Configure external PostgreSQL databases
@@ -22,3 +23,6 @@ include::../modules/configure_configuring-rhdh/proc-migrate-local-databases-to-a
2223

2324
:context: {previouscontext}
2425
:!previouscontext:
26+
27+
ifdef::parent-context[:context: {parent-context}]
28+
ifndef::parent-context[:!context:]

assemblies/configure_configuring-rhdh/assembly-configure-high-availability-in-rhdh.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
23

34
[id="configure-high-availability-in-rhdh_{context}"]
45
= Configure high availability in {product}
@@ -33,3 +34,6 @@ include::../modules/configure_configuring-rhdh/proc-configure-high-availability-
3334

3435
:context: {previouscontext}
3536
:!previouscontext:
37+
38+
ifdef::parent-context[:context: {parent-context}]
39+
ifndef::parent-context[:!context:]

assemblies/configure_configuring-rhdh/assembly-provision-and-use-your-custom-rhdh-configuration.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
23

34
[id="provision-and-use-your-custom-rhdh-configuration_{context}"]
45
= Provision and use your custom {product} configuration
@@ -17,3 +18,6 @@ include::../modules/configure_configuring-rhdh/proc-use-the-rhdh-helm-chart-to-r
1718

1819
:context: {previouscontext}
1920
:!previouscontext:
21+
22+
ifdef::parent-context[:context: {parent-context}]
23+
ifndef::parent-context[:!context:]

assemblies/configure_configuring-rhdh/assembly-rhdh-default-configuration.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
23

34
[id="rhdh-default-configuration_{context}"]
45
= {product} default configuration
@@ -17,3 +18,6 @@ include::../modules/configure_configuring-rhdh/ref-time-syntax-in-rhdh.adoc[leve
1718

1819
:context: {previouscontext}
1920
:!previouscontext:
21+
22+
ifdef::parent-context[:context: {parent-context}]
23+
ifndef::parent-context[:!context:]

assemblies/configure_configuring-rhdh/assembly-run-rhdh-behind-a-corporate-proxy.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
23

34
[id="run-rhdh-behind-a-corporate-proxy_{context}"]
45
= Run {product} behind a corporate proxy
@@ -27,3 +28,6 @@ include::../modules/configure_configuring-rhdh/proc-configure-proxy-information-
2728

2829
:context: {previouscontext}
2930
:!previouscontext:
31+
32+
ifdef::parent-context[:context: {parent-context}]
33+
ifndef::parent-context[:!context:]

assemblies/configure_configuring-rhdh/assembly-troubleshoot-rhdh-configuration-issues.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
23

34
[id="troubleshoot-rhdh-configuration-issues_{context}"]
45
= Troubleshoot {product-short} configuration issues
@@ -13,3 +14,6 @@ include::../modules/configure_configuring-rhdh/proc-fix-helm-overwriting-predefi
1314

1415
:context: {previouscontext}
1516
:!previouscontext:
17+
18+
ifdef::parent-context[:context: {parent-context}]
19+
ifndef::parent-context[:!context:]

assemblies/configure_configuring-rhdh/assembly-use-the-dynamic-plugins-cache.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
23

34
[id="use-the-dynamic-plugins-cache_{context}"]
45
= Use the dynamic plugins cache
@@ -21,3 +22,6 @@ include::../modules/configure_configuring-rhdh/proc-configure-the-dynamic-plugin
2122

2223
:context: {previouscontext}
2324
:!previouscontext:
25+
26+
ifdef::parent-context[:context: {parent-context}]
27+
ifndef::parent-context[:!context:]

assemblies/configure_customizing-rhdh/assembly-about-software-templates.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
23

34
[id="about-software-templates_{context}"]
45
= About Software Templates
@@ -14,7 +15,8 @@ include::../modules/shared/proc-version-a-software-template-in-rhdh.adoc[levelof
1415
include::../modules/shared/proc-enable-software-template-version-update-notifications-in-rhdh.adoc[leveloffset=+1]
1516

1617
[role="_additional-resources"]
17-
.Additional resources
18+
[role="_additional-resources"]
19+
== Additional resources
1820
* link:https://developers.redhat.com/articles/2025/03/17/10-tips-better-backstage-software-templates#[10 tips for better {backstage} Software Templates]
1921
* {authentication-book-link}#assembly-auth-provider-github[Enabling the GitHub authentication provider]
2022
* link:https://backstage.io/docs/features/software-templates/writing-templates/[{backstage} documentation - Writing Templates]
@@ -23,3 +25,6 @@ include::../modules/shared/proc-enable-software-template-version-update-notifica
2325

2426
:context: {previouscontext}
2527
:!previouscontext:
28+
29+
ifdef::parent-context[:context: {parent-context}]
30+
ifndef::parent-context[:!context:]

assemblies/configure_customizing-rhdh/assembly-automated-software-template-lifecycle-management.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
23

34
[id="automated-software-template-lifecycle-management_{context}"]
45
= Automated Software Template lifecycle management
@@ -19,3 +20,6 @@ include::../modules/shared/ref-template-synchronization-and-notification-outcome
1920

2021
:context: {previouscontext}
2122
:!previouscontext:
23+
24+
ifdef::parent-context[:context: {parent-context}]
25+
ifndef::parent-context[:!context:]

assemblies/configure_customizing-rhdh/assembly-configure-a-floating-action-button-in-rhdh.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
23

34
[id="configure-a-floating-action-button-in-rhdh_{context}"]
45
= Configure a floating action button in {product}
@@ -21,3 +22,6 @@ include::../modules/shared/ref-floating-action-button-parameters.adoc[leveloffse
2122

2223
:context: {previouscontext}
2324
:!previouscontext:
25+
26+
ifdef::parent-context[:context: {parent-context}]
27+
ifndef::parent-context[:!context:]

0 commit comments

Comments
 (0)