Skip to content

Commit 08fe0a0

Browse files
themr0cclaude
andauthored
RHIDP-12727: CQA 2.1 compliance for configure_techdocs-for-rhdh (#1945)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent e71b85f commit 08fe0a0

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

build/scripts/cqa-10-titles-are-brief-complete-and-descriptive.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,7 @@ if [ "$EXPECTED_FORM" = "imperative" ]; then
460460
if [[ ! "$FIRST_WORD_CHECK" =~ ^\{.*\}$ ]]; then
461461
FIRST_LOWER=$(echo "$FIRST_WORD_CHECK" | tr '[:upper:]' '[:lower:]')
462462
# Known valid imperative verbs (from gerund_to_imperative + common doc verbs)
463-
KNOWN_IMPERATIVES=" run set get put cut stop drop map plan scan ship shop skip snap spin split step strip swap tap trim wrap begin configure create enable disable manage upgrade update remove delete edit resolve authorize validate customize integrate migrate generate define override retrieve prepare scale secure authenticate automate bootstrap restore replace browse close compose describe ensure use include invoke provide produce reduce release require subscribe change locate navigate operate isolate install deploy build add test monitor check import export connect disconnect adjust restart start register unregister assign review access fetch search find provision encrypt mount unmount attach detach extend limit inspect trigger troubleshoot understand publish select track transform view verify modify specify apply send download design delegate determine gather interact "
463+
KNOWN_IMPERATIVES=" run set get put cut stop drop map plan scan ship shop skip snap spin split step strip swap tap trim wrap begin configure create enable disable manage upgrade update remove delete edit resolve authorize validate customize integrate migrate generate define override retrieve prepare scale secure authenticate automate bootstrap restore replace browse close compose describe ensure use include invoke provide produce reduce release require subscribe change locate navigate operate isolate install deploy build add test monitor check import export connect disconnect adjust restart start register unregister assign review access fetch search find provision encrypt mount unmount attach detach extend limit inspect trigger troubleshoot understand publish select track transform view verify modify specify apply send download design delegate determine gather interact make "
464464
if ! echo "$KNOWN_IMPERATIVES" | grep -q " ${FIRST_LOWER} "; then
465465
echo " ⚠ Title starts with '${FIRST_WORD_CHECK}' which is not a recognized imperative verb (possible truncation?)"
466466
WILL_CHANGE=true

modules/shared/proc-install-and-configure-an-external-techdocs-add-on-using-the-operator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ where:
6363
_<external_techdocs_add-on>_:: Specifies the external TechDocs add-on that you want to install, for example, `TextSize` or `LightBox`.
6464
. Click *Create*.
6565
. In the web console navigation menu, click *Topology*.
66-
. Click on the overflow menu for the {product} instance that you want to use and select *Edit Backstage* to load the YAML view of the {product} instance.
66+
. Click on the overflow menu for the {product} instance that you want to use and select *Edit {product-custom-resource-type}* to load the YAML view of the {product} instance.
6767
. In your `{product-custom-resource-type}` CR, add the `dynamicPluginsConfigMapName: _<dynamic_plugins_configmap>_` key-value pair. For example:
6868
+
6969
[source,yaml]

0 commit comments

Comments
 (0)