Update OCP documentation links to latest versions #327

sebrandon1 · 2025-10-16T20:13:09Z

This PR updates OpenShift Container Platform documentation URLs to point to the latest available versions.

Changes

Automatically updated OCP documentation links using ocp-doc-checker
All documentation URLs now point to current versions

Tool Information

This PR was created automatically by scanning the repository with ocp-doc-checker, which identifies and updates outdated OpenShift documentation links.

Repository: https://github.com/sebrandon1/ocp-doc-checker

Tracking Issue: sebrandon1/ocp-doc-checker#18

This commit updates OpenShift Container Platform documentation URLs to point to the latest available versions. Updated by: ocp-doc-checker More info: https://github.com/sebrandon1/ocp-doc-checker

coderabbitai · 2025-10-16T20:13:43Z

Walkthrough

Two documentation links in docs/operand_metrics.md were updated to reference OpenShift Container Platform 4.20 instead of 4.18; changes occur in the "Enable User Workload Monitoring" and "Query Metrics" sections. No code or exported entities were modified.

Changes

Cohort / File(s)	Summary
Documentation version updates `docs/operand_metrics.md`	Updated OpenShift Container Platform documentation links from version 4.18 to 4.20 in two sections: "Enable User Workload Monitoring" (ConfigMap doc) and "Query Metrics" (Accessing metrics doc).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title "Update OCP documentation links to latest versions" directly relates to the main change in the changeset. The raw summary confirms that documentation links were updated within the operand_metrics.md file, and the pr_objectives indicate that the links were updated to reference the latest available versions (specifically using the "latest" path after community discussion). The title is concise, specific, and clearly communicates the primary purpose of the changes without being vague or overly broad.
Description Check	✅ Passed	The pull request description is clearly related to the changeset and provides relevant context about the updates. It explicitly states that OCP documentation URLs were updated to point to the latest available versions, mentions the automated tool used (ocp-doc-checker), and references the tracking issue. The description is sufficiently specific and not vague, as it explains both what was changed and how the changes were made, making it easy for reviewers to understand the purpose and scope of the PR.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 25b7fa2 and bff49cd.

📒 Files selected for processing (1)

docs/operand_metrics.md (2 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

openshift-ci · 2025-10-16T20:14:00Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sebrandon1
Once this PR has been reviewed and has the lgtm label, please assign lunarwhite for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

docs/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

bharath-b-rh · 2025-10-17T14:49:55Z

docs/operand_metrics.md

 ### Enable User Workload Monitoring

-Cluster administrators can enable monitoring for user-defined projects by setting the `enableUserWorkload: true` field in the cluster monitoring ConfigMap object. For more details, Please look at the detailed documentation to [Configuring user workload monitoring](https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/monitoring/configuring-user-workload-monitoring).
+Cluster administrators can enable monitoring for user-defined projects by setting the `enableUserWorkload: true` field in the cluster monitoring ConfigMap object. For more details, Please look at the detailed documentation to [Configuring user workload monitoring](https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/monitoring/configuring-user-workload-monitoring).


Suggested change

Cluster administrators can enable monitoring for user-defined projects by setting the `enableUserWorkload: true` field in the cluster monitoring ConfigMap object. For more details, Please look at the detailed documentation to [Configuring user workload monitoring](https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/monitoring/configuring-user-workload-monitoring).

Cluster administrators can enable monitoring for user-defined projects by setting the `enableUserWorkload: true` field in the cluster monitoring ConfigMap object. For more details, Please look at the detailed documentation to [Configuring user workload monitoring](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/monitoring/configuring-user-workload-monitoring).

bharath-b-rh · 2025-10-17T14:49:58Z

docs/operand_metrics.md

 ### Query Metrics

-As a cluster administrator or as a user with view permissions for all projects, You can access these metrics using the command line or via the OpenShift web console. For more details, Please look at the detailed documentation to [Accessing metrics](https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/monitoring/accessing-metrics).
+As a cluster administrator or as a user with view permissions for all projects, You can access these metrics using the command line or via the OpenShift web console. For more details, Please look at the detailed documentation to [Accessing metrics](https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/monitoring/accessing-metrics).


Suggested change

As a cluster administrator or as a user with view permissions for all projects, You can access these metrics using the command line or via the OpenShift web console. For more details, Please look at the detailed documentation to [Accessing metrics](https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/monitoring/accessing-metrics).

As a cluster administrator or as a user with view permissions for all projects, You can access these metrics using the command line or via the OpenShift web console. For more details, Please look at the detailed documentation to [Accessing metrics](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/monitoring/accessing-metrics).

sebrandon1 · 2025-10-20T16:12:29Z

@bharath-b-rh Would you rather them be latest instead of pointing to a certain release? I can change it if so.

bharath-b-rh · 2025-10-22T11:41:23Z

@bharath-b-rh Would you rather them be latest instead of pointing to a certain release? I can change it if so.

I feel so, since cert-manager releases aren't directly mapped to OCP releases. The latest always gets translated to the current release, and we wouldn't need to update it after every OCP release.

This commit updates OpenShift Container Platform documentation URLs to point to the latest available versions. Updated by: ocp-doc-checker More info: https://github.com/sebrandon1/ocp-doc-checker

sebrandon1 · 2025-10-24T14:20:31Z

Updated with latest OCP documentation links (ran ocp-doc-checker again).

All documentation URLs now point to the latest available versions.

openshift-ci · 2025-10-24T14:35:09Z

@sebrandon1: all tests passed!

Full PR test history. Your PR dashboard.

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.

lunarwhite

@sebrandon1 first off thanks for your PR!

I assume we don't really need to worry about a version is not "latest" in this markdown doc. The equivalent content for customers reference is already there at https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/security_and_compliance/cert-manager-operator-for-red-hat-openshift#cert-manager-monitoring

My major concern is sometimes the RH docs paths would change between major releases. That means https://docs.redhat.com/.../<a future version>/html/monitoring/configuring-user-workload-monitoring might not always work. But what we could confirm is that 4.18 is not broken and won't be broken in the future.

I'd lean towards we keep it as-is to avoid bumping it every release and verifying if it's still valid. WDYT?

Update OCP documentation links to latest versions

25b7fa2

This commit updates OpenShift Container Platform documentation URLs to point to the latest available versions. Updated by: ocp-doc-checker More info: https://github.com/sebrandon1/ocp-doc-checker

openshift-ci bot requested review from TrilokGeer and lunarwhite October 16, 2025 20:13

bharath-b-rh reviewed Oct 17, 2025

View reviewed changes

Update OCP documentation links to latest versions

bff49cd

This commit updates OpenShift Container Platform documentation URLs to point to the latest available versions. Updated by: ocp-doc-checker More info: https://github.com/sebrandon1/ocp-doc-checker

lunarwhite suggested changes Oct 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update OCP documentation links to latest versions #327

Update OCP documentation links to latest versions #327

Uh oh!

sebrandon1 commented Oct 16, 2025

Uh oh!

coderabbitai bot commented Oct 16, 2025 •

edited

Loading

Uh oh!

openshift-ci bot commented Oct 16, 2025

Uh oh!

bharath-b-rh Oct 17, 2025

Uh oh!

bharath-b-rh Oct 17, 2025

Uh oh!

sebrandon1 commented Oct 20, 2025

Uh oh!

bharath-b-rh commented Oct 22, 2025

Uh oh!

sebrandon1 commented Oct 24, 2025

Uh oh!

openshift-ci bot commented Oct 24, 2025

Uh oh!

lunarwhite left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	Cluster administrators can enable monitoring for user-defined projects by setting the `enableUserWorkload: true` field in the cluster monitoring ConfigMap object. For more details, Please look at the detailed documentation to [Configuring user workload monitoring](https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/monitoring/configuring-user-workload-monitoring).
	Cluster administrators can enable monitoring for user-defined projects by setting the `enableUserWorkload: true` field in the cluster monitoring ConfigMap object. For more details, Please look at the detailed documentation to [Configuring user workload monitoring](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/monitoring/configuring-user-workload-monitoring).

	As a cluster administrator or as a user with view permissions for all projects, You can access these metrics using the command line or via the OpenShift web console. For more details, Please look at the detailed documentation to [Accessing metrics](https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/monitoring/accessing-metrics).
	As a cluster administrator or as a user with view permissions for all projects, You can access these metrics using the command line or via the OpenShift web console. For more details, Please look at the detailed documentation to [Accessing metrics](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/monitoring/accessing-metrics).

Update OCP documentation links to latest versions #327

Are you sure you want to change the base?

Update OCP documentation links to latest versions #327

Uh oh!

Conversation

sebrandon1 commented Oct 16, 2025

Changes

Tool Information

Uh oh!

coderabbitai bot commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Pre-merge checks and finishing touches

Uh oh!

openshift-ci bot commented Oct 16, 2025

Uh oh!

bharath-b-rh Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

bharath-b-rh Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

sebrandon1 commented Oct 20, 2025

Uh oh!

bharath-b-rh commented Oct 22, 2025

Uh oh!

sebrandon1 commented Oct 24, 2025

Uh oh!

openshift-ci bot commented Oct 24, 2025

Uh oh!

lunarwhite left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

coderabbitai bot commented Oct 16, 2025 •

edited

Loading