OSDOCS-17079-1: CQA 2.0 for SUPP-1: Remote Health Monitoring (Insight… by dfitzmau · Pull Request #114766 · openshift/openshift-docs

dfitzmau · 2026-07-07T15:37:05Z

Version(s):
4.20+

Link to docs preview:

openshift-ci-robot · 2026-07-07T15:37:08Z

@dfitzmau: This pull request references OSDOCS-17079 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Version(s):
4.20+

Issue:
OSDOCS-17079

Link to docs preview:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-previewbot · 2026-07-07T15:55:22Z

🤖 Wed Jul 08 10:37:39 - Prow CI generated the docs preview:

…s Operator)

openshift-ci · 2026-07-08T10:39:49Z

@dfitzmau: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

lahinson

@dfitzmau A few nits and comments for your consideration. I'll mark this one as ok-to-merge so you can merge when you're ready.

lahinson · 2026-07-09T15:54:07Z

@@ -31,13 +30,16 @@ ifdef::openshift-rosa,openshift-dedicated[]
 endif::openshift-rosa,openshift-dedicated[]
 * The *insights-config* `ConfigMap` object exists in the `openshift-insights` namespace.


Suggested change

* The *insights-config* `ConfigMap` object exists in the `openshift-insights` namespace.

* The `insights-config` `ConfigMap` object exists in the `openshift-insights` namespace.

lahinson · 2026-07-09T15:54:51Z


 . Go to *Workloads* -> *ConfigMaps* and select *Project: openshift-insights*.
+
 . Click on the *insights-config* `ConfigMap` object to open it.


Suggested change

. Click on the *insights-config* `ConfigMap` object to open it.

. Click the *insights-config* `ConfigMap` object to open it.

ISG advises to use "click" instead of "click on": https://www.ibm.com/docs/en/ibm-style?topic=word-usage#click

lahinson · 2026-07-09T16:01:55Z


 [NOTE]
 ====
 Previously, a cluster administrator would create or edit the {insights-operator} configuration using a *support secret* in the `openshift-config` namespace. {red-hat-lightspeed} now supports the creation of a `ConfigMap` object to configure the {insights-operator}. The {insights-operator} gives preference to the config map configuration over the support secret if both exist.


In modules/disabling-insights-operator-alerts.adoc, you removed the bold formatting from the phrase "support secret". Just wondering if you need to do the same thing here.

lahinson · 2026-07-09T16:02:51Z

 = Enabling {insights-operator} alerts

 [role="_abstract"]
 When alerts are disabled, the {insights-operator} no longer sends alerts to the cluster Prometheus instance. You can reenable them.


Suggested change

When alerts are disabled, the {insights-operator} no longer sends alerts to the cluster Prometheus instance. You can re-enable them.

lahinson · 2026-07-09T16:09:39Z

+
+[NOTE]
+====
+The *insights-config* `ConfigMap` object follows standard YAML formatting, wherein child values are below the parent attribute and indented two spaces. For the *Obfuscation* attribute, enter values as bulleted children of the parent attribute.


Suggested change

The *insights-config* `ConfigMap` object follows standard YAML formatting, wherein child values are below the parent attribute and indented two spaces. For the *Obfuscation* attribute, enter values as bulleted children of the parent attribute.

The `insights-config` `ConfigMap` object follows standard YAML formatting, wherein child values are below the parent attribute and indented two spaces. For the `Obfuscation` attribute, enter values as bulleted children of the parent attribute.

Just a couple formatting nits to maintain consistency with other docs.

lahinson · 2026-07-09T16:12:59Z

 ----
-* To enable persistent storage to retain the data archive file and history for up to the last 10 data gathering jobs, define the `storage` specification. Set *type* to `PersistentVolume`, and define the `mountPath` and `name` of the volume, as outlined in the following example:
+
+* To enable persistent storage to retain the data archive file and history for up to the last 10 data gathering jobs, define the `storage` specification. Set *type* to `PersistentVolume`, and define the `mountPath` and `name` of the volume:


Should "type" be in bold, or in monospace font?

lahinson · 2026-07-09T16:15:32Z

+
+:_mod-docs-content-type: CONCEPT
+[id="running-insights-operator-gather_{context}"]
+= Running an {insights-operator} gather operation on-demand


Since this is a concept module, I believe the title should be a noun phrase instead of a gerund. Here's a suggestion:

Suggested change

= Running an {insights-operator} gather operation on-demand

= On-demand {insights-operator} gather operations

lahinson · 2026-07-09T16:16:09Z


 [role="_abstract"]
-In {product-title}, customers can disable reporting usage information.
+You can disable reporting usage information but understand potential consequences before doing so.


Suggested change

You can disable reporting usage information but understand potential consequences before doing so.

You can disable reporting usage information, but understand potential consequences before doing so.

lahinson · 2026-07-09T16:17:14Z

-
 :_mod-docs-content-type: CONCEPT
 [id="understanding-insights-operator-alerts_{context}"]
 = Understanding {insights-operator} alerts


I believe the title should be a noun phrase since this is a concept module.

Suggested change

= Understanding {insights-operator} alerts

= {insights-operator} alerts

lahinson · 2026-07-09T16:19:16Z


 toc::[]

 [role="_abstract"]


I noticed in the preview that the short description contains a URL. I didn't think that was allowed, so it would be good to double-check.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 7, 2026

openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 7, 2026

dfitzmau force-pushed the OSDOCS-17079-1 branch 2 times, most recently from 36dad76 to 224564f Compare July 7, 2026 15:46

ocpdocs-vale-bot reviewed Jul 7, 2026

View reviewed changes

Comment thread modules/running-insights-operator-gather_using-insights-operator.adoc Outdated

dfitzmau force-pushed the OSDOCS-17079-1 branch 3 times, most recently from 9dacc12 to 54ce47d Compare July 8, 2026 08:47

dfitzmau added branch/enterprise-4.20 branch/enterprise-4.21 branch/enterprise-4.22 branch/enterprise-5.0 labels Jul 8, 2026

dfitzmau force-pushed the OSDOCS-17079-1 branch 2 times, most recently from e9315f7 to e2f988e Compare July 8, 2026 09:41

dfitzmau added the merge-review-needed Signifies that the merge review team needs to review this PR label Jul 8, 2026

dfitzmau force-pushed the OSDOCS-17079-1 branch from e2f988e to e024d89 Compare July 8, 2026 10:19

OSDOCS-17079-1: CQA 2.0 for SUPP-1: Remote Health Monitoring (Insight…

e1b4d4c

…s Operator)

dfitzmau force-pushed the OSDOCS-17079-1 branch from e024d89 to e1b4d4c Compare July 8, 2026 10:20

lahinson added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Jul 9, 2026

lahinson reviewed Jul 9, 2026

View reviewed changes

lahinson added ok-to-merge and removed merge-review-in-progress Signifies that the merge review team is reviewing this PR labels Jul 9, 2026

		@@ -31,13 +30,16 @@ ifdef::openshift-rosa,openshift-dedicated[]
		endif::openshift-rosa,openshift-dedicated[]
		* The insights-config `ConfigMap` object exists in the `openshift-insights` namespace.

	* The insights-config `ConfigMap` object exists in the `openshift-insights` namespace.
	* The `insights-config` `ConfigMap` object exists in the `openshift-insights` namespace.


		. Go to Workloads -> ConfigMaps and select Project: openshift-insights.

		. Click on the insights-config `ConfigMap` object to open it.

	. Click on the insights-config `ConfigMap` object to open it.
	. Click the insights-config `ConfigMap` object to open it.


	When alerts are disabled, the {insights-operator} no longer sends alerts to the cluster Prometheus instance. You can re-enable them.

	The insights-config `ConfigMap` object follows standard YAML formatting, wherein child values are below the parent attribute and indented two spaces. For the Obfuscation attribute, enter values as bulleted children of the parent attribute.
	The `insights-config` `ConfigMap` object follows standard YAML formatting, wherein child values are below the parent attribute and indented two spaces. For the `Obfuscation` attribute, enter values as bulleted children of the parent attribute.

	= Running an {insights-operator} gather operation on-demand
	= On-demand {insights-operator} gather operations

	You can disable reporting usage information but understand potential consequences before doing so.
	You can disable reporting usage information, but understand potential consequences before doing so.

	= Understanding {insights-operator} alerts
	= {insights-operator} alerts

Uh oh!

Conversation

dfitzmau commented Jul 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Jul 7, 2026 • edited by openshift-ci Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Jul 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

openshift-ci Bot commented Jul 8, 2026

Uh oh!

lahinson left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dfitzmau commented Jul 7, 2026 •

edited

Loading

openshift-ci-robot commented Jul 7, 2026 •

edited by openshift-ci Bot

Loading

ocpdocs-previewbot commented Jul 7, 2026 •

edited

Loading