Skip to content

Commit 14ee0f2

Browse files
themr0cclaude
andauthored
[RHDHBUGS-2953]: Resolve all existing CQA violations on main branch (#2052)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 7905006 commit 14ee0f2

File tree

11 files changed

+36
-18
lines changed

11 files changed

+36
-18
lines changed

artifacts/attributes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,5 +202,7 @@
202202
:upgrading-book-title: Upgrading {product}
203203
:using-dynamic-plugins-book-link: {product-docs-link}/html-single/using_dynamic_plugins_in_red_hat_developer_hub/index
204204
:using-dynamic-plugins-book-title: Using dynamic plugins in {product}
205+
:explore_preview_of_emerging_and_supplemental_capabilities-book-title: Explore preview of emerging and supplemental capabilities
206+
:explore_preview_of_emerging_and_supplemental_capabilities-book-link: {product-docs-link}/html-single/explore_preview_of_emerging_and_supplemental_capabilities/index
205207

206208

modules/configure_configuring-rhdh/proc-configure-an-rhdh-instance-with-a-tls-connection-in-kubernetes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
[role="_abstract"]
77
Configure {product-very-short} with a TLS connection in Kubernetes to ensure secure connections with third-party applications and external databases.
88

9+
include::{docdir}/artifacts/snip-technology-preview.adoc[]
10+
911
.Prerequisites
1012

1113
* You have set up an {azure-short} Red Hat OpenShift (ARO) cluster with a public CA-signed certificate. For more information about obtaining CA certificates, refer to your vendor documentation.

modules/observability_audit-logs-in-rhdh/ref-rbac-audit-log-events.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,17 @@ RBAC audit logs contain a `meta` object with event-specific details:
3232

3333
== Example audit log entries
3434

35-
The following examples show how RBAC events appear in the {product-short} logs:
35+
The following examples show how RBAC events appear in the {product-short} logs.
36+
37+
An RBAC role creation event with `status="initiated"`:
3638

37-
.Example: RBAC role creation (initiated)
3839
[source,text]
3940
----
4041
[backend]: 2025-03-25T17:24:17.438Z permission info permission.role-write isAuditEvent=true eventId="role-write" severityLevel="medium" actor={"actorId":"user:default/admin","ip":"::1"} request={"url":"/api/permission/roles","method":"POST"} meta={"actionType":"create", "source":"rest"} status="initiated"
4142
----
4243

43-
.Example: RBAC role creation (succeeded)
44+
An RBAC role creation event with `status="succeeded"`:
45+
4446
[source,text]
4547
----
4648
[backend]: 2025-03-25T17:24:17.458Z permission info permission.role-write isAuditEvent=true eventId="role-write" severityLevel="medium" actor={"actorId":"user:default/admin"} request={"url":"/api/permission/roles","method":"POST"} meta={"actionType":"create", "source":"rest","roleEntityRef":"role:default/test-role"} status="succeeded"

titles/additional-rhdh-capabilities/master.adoc

Lines changed: 0 additions & 10 deletions
This file was deleted.

titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc renamed to titles/additional_title-additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ The content in this document describes preview or early-stage capabilities that
66

77
Where applicable, individual features retain their respective support status (for example, Supported, Technology Preview, or Developer Preview). Refer to the feature-specific documentation for details about the link:https://access.redhat.com/support[support] scope.
88

9+
include::../artifacts/snip-technology-preview.adoc[]
10+
11+
include::../artifacts/snip-developer-preview.adoc[]
12+
913
== Integrate Argo CD notifications with {product}
1014

1115
This guide explains how to configure Argo CD to send notifications directly to the {product} ({product-very-short}) Notifications plugin when application sync events occur.
@@ -516,7 +520,7 @@ spec:
516520

517521
=== Troubleshooting
518522

519-
==== Notifications not appearing in {product-very-short}
523+
=== Notifications not appearing in {product-very-short}
520524

521525
1. **Check notifications controller is running:**
522526
+
@@ -553,7 +557,7 @@ kubectl get configmap argocd-notifications-cm -n openshift-gitops -o jsonpath='{
553557
kubectl get application my-app -n openshift-gitops -o jsonpath='{.metadata.annotations}' | jq .
554558
----
555559

556-
==== "notification service 'backstage' is not supported"
560+
=== "notification service 'backstage' is not supported"
557561

558562
This error means the webhook service is not configured.
559563

@@ -564,7 +568,7 @@ Common causes include the following:
564568

565569
**Solution:** Use the `NotificationsConfiguration` CR for OpenShift GitOps (see Part 2).
566570

567-
==== Webhook Returns 400 Bad Request / "not valid JSON"
571+
=== Webhook Returns 400 Bad Request / "not valid JSON"
568572

569573
This means the trigger is using the wrong template format (text instead of JSON).
570574

@@ -579,7 +583,7 @@ Common causes include the following:
579583
* Trigger: `trigger.on-sync-succeeded-backstage`
580584
* Subscription: `notifications.argoproj.io/subscribe.on-sync-succeeded-backstage.backstage`
581585

582-
==== Link Shows *<no value>* or Broken URL
586+
=== Link Shows *<no value>* or Broken URL
583587

584588
The `{{.context.argocdUrl}}` template variable is not configured.
585589

@@ -606,7 +610,7 @@ data:
606610
argocdUrl: https://your-argocd-url.com
607611
----
608612

609-
==== Authentication Errors
613+
=== Authentication Errors
610614

611615
If you see `401 Unauthorized` or token errors:
612616

titles/additional-rhdh-capabilities/artifacts renamed to titles/additional_title-additional-rhdh-capabilities/artifacts

File renamed without changes.

titles/additional-rhdh-capabilities/assemblies renamed to titles/additional_title-additional-rhdh-capabilities/assemblies

File renamed without changes.

titles/additional-rhdh-capabilities/docinfo.xml renamed to titles/additional_title-additional-rhdh-capabilities/docinfo.xml

File renamed without changes.
File renamed without changes.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:_mod-docs-category: Additional
3+
4+
include::artifacts/attributes.adoc[]
5+
:title: {explore_preview_of_emerging_and_supplemental_capabilities-book-title}
6+
:context: title-additional-rhdh-capabilities
7+
:subtitle: Explore features that are new, evolving, or not yet fully covered in the core product documentation
8+
:abstract: Explore emerging, evolving, and supplemental capabilities in {product}, including new features and supported functionality not yet fully covered in the core documentation.
9+
:imagesdir: images
10+
11+
= {title}
12+
13+
[role="_abstract"]
14+
{abstract}
15+
16+
include::artifacts/snip-developer-preview.adoc[]
17+
18+
include::additional-capabilities/additional-rhdh-capabilities.adoc[]

0 commit comments

Comments
 (0)