OSDOCS -16577 [ROSA] Vale Errors: Cluster Admin by jc-berger · Pull Request #108402 · openshift/openshift-docs

jc-berger · 2026-03-16T17:50:28Z

Version(s):
4.20+

Issue:
https://redhat.atlassian.net/browse/OSDOCS-16577

Link to docs preview:
https://108402--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/rosa_cluster_admin/rosa-cluster-notifications.html

QE review:

QE has approved this change.

Additional information:

ocpdocs-previewbot · 2026-03-16T17:57:51Z

🤖 Tue Mar 17 17:19:35 - Prow CI generated the docs preview:

https://108402--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/rosa_cluster_admin/rosa-cluster-autoscaling-hcp.html
https://108402--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/rosa_cluster_admin/rosa-cluster-notifications.html
https://108402--ocpdocs-pr.netlify.app/openshift-rosa/latest/rosa_cluster_admin/rosa-cluster-autoscaling.html
https://108402--ocpdocs-pr.netlify.app/openshift-rosa/latest/rosa_cluster_admin/rosa-cluster-notifications.html

openshift-ci · 2026-03-17T15:22:37Z

New changes are detected. LGTM label has been removed.

jc-berger · 2026-03-17T16:58:59Z


 //ROSA HCP procedure
 ifdef::openshift-rosa-hcp[]
-.Procedure


Reviewers:

Vale flagged .Procedure as a DITA violation for "block titles"

However, I see a lot of our modules do have the .Procedure title, so perhaps it's only a DITA violation when it's in an assembly?

Let me know if you want it removed or kept, thanks!

Yup, keep the .Procedure since that's required for :_mod-docs-content-type: PROCEDURE. I would move the .procedure to line 12, then conditionalize the differences

jc-berger · 2026-03-17T17:01:02Z

-
-If your cluster does not receive notifications:
+[role="_additional-resources"]
+.Additional resources


Reviewers:

I see we're allowed to have "Additional resources" for assemblies. I I documented it as .Additional resources instead of ==Additional resources because that's consistent with other files in the rosa_cluster_admin book.

For the wider ROSA docs, I see we have it documented both ways, so let me know your preference, thanks!

jc-berger · 2026-03-17T17:02:14Z

+.Additional resources

-* Ensure that your cluster can access resources at `api.openshift.com`.
+* link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.adoc#notifications_rosa-policy-responsibility-matrix[Customer responsibilities: Review and action cluster notifications]


Reviewers:

Vale wanted me to remove xrefs, and since some of those xrefs are now include statements, I thought it's an appropriate change.

Let me know if you think the "Additional resources" here is flushed out enough though to still help users, thanks!

openshift-ci · 2026-03-17T17:19:59Z

@jc-berger: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/validate-portal	`40c62de`	link	true	`/test validate-portal`
ci/prow/validate-asciidoc	`40c62de`	link	true	`/test validate-asciidoc`

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.

EricPonvelle

Small nitpicks

EricPonvelle · 2026-03-17T17:48:31Z


 //ROSA HCP procedure
 ifdef::openshift-rosa-hcp[]
-.Procedure


Yup, keep the .Procedure since that's required for :_mod-docs-content-type: PROCEDURE. I would move the .procedure to line 12, then conditionalize the differences

EricPonvelle · 2026-03-17T17:50:10Z

+
+Pods with priority lower than the cutoff value do not cause the cluster to scale up or prevent the cluster from scaling down. No new nodes are added to run the pods, and nodes running these pods might be deleted to free resources.
+
+include::modules/rosa-cluster-autoscaler-cli-interactive-during.adoc[leveloffset=+1]


We cannot have includes within a module.

EricPonvelle · 2026-03-17T17:52:02Z

+[role="_abstract"]
+By default, when a cluster notification is sent to the cluster, it is also sent as an email to the cluster owner. You can configure additional recipients for notification emails to ensure that all appropriate users remain informed about the state of the cluster.
+
+include::modules/managed-cluster-add-notification-contacts.adoc[leveloffset=+2]


Same as previous comment: we cannot have includes within a module.

EricPonvelle · 2026-03-17T17:52:38Z

+$ rosa edit autoscaler --cluster=<mycluster>
+----
+
+** To edit a specific parameter, run the following command:


I think this is just a single * because it's either editing the cluster wide autoscaler or a parameter.

EricPonvelle · 2026-03-17T17:52:55Z

+[role="_abstract"]
+As a cluster administrator, you need to be aware of when and why cluster notifications are sent, as well as their types and severity levels, in order to effectively understand the health and administration needs of your cluster.
+
+include::modules/managed-cluster-notification-policy.adoc[leveloffset=+2]


Same as previous; cannot have includes within a module.

EricPonvelle · 2026-03-17T17:53:14Z

+//
+// * rosa_cluster_admin/rosa-cluster-notifications.adoc
+
+:_mod-docs-content-type: PROCEDURE


This should be a CONCEPT type.

jc-berger · 2026-03-18T17:53:38Z

Please see this PR instead for the Vale changes: https://github.com/openshift/openshift-docs/pull/108636/changes

openshift-ci Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 16, 2026

jc-berger commented Mar 16, 2026

View reviewed changes

Comment thread rosa_cluster_admin/rosa-cluster-notifications.adoc

openshift-ci Bot assigned EricPonvelle Mar 16, 2026

openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Mar 16, 2026

jc-berger force-pushed the jcberger-16577-vale-cluster-admin branch from 6b46f2f to 2def691 Compare March 17, 2026 15:22

openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Mar 17, 2026

openshift-ci Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 17, 2026

jc-berger commented Mar 17, 2026

View reviewed changes

jc-berger force-pushed the jcberger-16577-vale-cluster-admin branch from 9be2df1 to cdda581 Compare March 17, 2026 17:05

jc-berger added 2 commits March 17, 2026 13:12

ROSA-16577 Vale Errors: Cluster Admin

650ed40

more changes for DITA

40c62de

jc-berger force-pushed the jcberger-16577-vale-cluster-admin branch from cdda581 to 40c62de Compare March 17, 2026 17:12

EricPonvelle reviewed Mar 17, 2026

View reviewed changes

jc-berger closed this Mar 18, 2026


		Pods with priority lower than the cutoff value do not cause the cluster to scale up or prevent the cluster from scaling down. No new nodes are added to run the pods, and nodes running these pods might be deleted to free resources.

		include::modules/rosa-cluster-autoscaler-cli-interactive-during.adoc[leveloffset=+1]

Conversation

jc-berger commented Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Mar 16, 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 Mar 17, 2026

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!

openshift-ci Bot commented Mar 17, 2026

Uh oh!

EricPonvelle 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!

jc-berger commented Mar 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jc-berger commented Mar 16, 2026 •

edited

Loading

ocpdocs-previewbot commented Mar 16, 2026 •

edited

Loading