Skip to content

Update OCP documentation links to latest versions #3517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sebrandon1 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update OCP documentation links to latest versions #3517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,13 +318,13 @@ autoscaling support is not available for Windows workloads.

### Other limitations
WMCO / Windows nodes does not work with the following products:
* [odo](https://docs.redhat.com/en/documentation/openshift_container_platform/4.8/html/cli_tools/developer-cli-odo)
* [odo](https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/cli_tools/developer-cli-odo)
* [OpenShift Builds](https://docs.redhat.com/en/documentation/builds_for_red_hat_openshift/1.4/html/about_builds/overview-of-builds)
* [OpenShift Pipelines](https://docs.redhat.com/en/documentation/red_hat_openshift_pipelines/1.17/html-single/about_openshift_pipelines/index)
* [OpenShift Service Mesh](https://docs.redhat.com/en/documentation/openshift_container_platform/4.1/html/service_mesh/service-mesh-architecture#understanding-service-mesh)
* [Red Hat Insights cost management](https://docs.redhat.com/en/documentation/cost_management_service/1-latest)
* [Red Hat OpenShift Local](https://developers.redhat.com/products/openshift-local/overview)
* [OpenShift monitoring of user defined project](https://docs.redhat.com/en/documentation/openshift_container_platform/4.10/html/monitoring/enabling-monitoring-for-user-defined-projects)
* [OpenShift monitoring of user defined project](https://docs.redhat.com/en/documentation/openshift_container_platform/4.13/html/monitoring/enabling-monitoring-for-user-defined-projects)
Copy link

@mburke5678 mburke5678 Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we use this link instead? Is this the same module in 4.20 as the 4.15?
https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/monitoring/configuring-user-workload-monitoring#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm

Copy link
Member Author

@sebrandon1 sebrandon1 Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So my tool just looks for if the URL + version + #anchor stays the same and nothing else changes. If the actual URL + version + anchor needs a change like that I'd say it'd be a separate change.

Copy link
Member Author

@sebrandon1 sebrandon1 Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like 4.13 is that last version where that URL + #anchor stays the same.

Copy link
Contributor

@jrvaldes jrvaldes Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend using the 4.20 equivalent

https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm

Copy link
Member Author

@sebrandon1 sebrandon1 Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed! I think that might have to be a separate change though because the underlying URL + #anchor is different than the original. I can help open up a separate PR after this one merges if needed?

* [HugePages](https://kubernetes.io/docs/tasks/manage-hugepages/scheduling-hugepages/)

### Trunk port
Expand Down
2 changes: 1 addition & 1 deletion docs/HACKING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ opm index rm --from-index $INDEX_IMAGE:$INDEX_TAG
```
#### Create a CatalogSource using the index

See the OpenShift docs for [adding a CatalogSource to a cluster](https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/extensions/catalogs)
See the OpenShift docs for [adding a CatalogSource to a cluster](https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/extensions/catalogs)

#### Create a subscription object

Expand Down
2 changes: 1 addition & 1 deletion docs/TROUBLESHOOTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ not yet supported for Windows. Instead, a Windows node can be accessed using SSH
[SSH bastion](https://github.com/eparis/ssh-bastion) needs to be setup for both methods. The following information is
common across both methods:
* The key used in the *cloud-private-key* [secret](../README.md#Usage) and the key used when creating the cluster should
be added to the [ssh-agent](https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/installing_on_azure/installing-azure-default#ssh-agent-using_installing-azure-default).
be added to the [ssh-agent](https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/installing_on_azure/installing-azure-default#ssh-agent-using_installing-azure-default).
Copy link

@mburke5678 mburke5678 Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we use this link instead? Is this the same module in 4.20 as the 4.15?
https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/installing_on_azure/installer-provisioned-infrastructure#ssh-agent-using_installing-azure-preparing-ipi

Copy link
Contributor

@jrvaldes jrvaldes Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Copy link
Contributor

@jrvaldes jrvaldes Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mburke5678 is it still safe to use the latest placeholder in the links to resolve the latest?

for example: https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm

For [security reasons](https://manpages.debian.org/buster/openssh-client/ssh.1.en.html#A) we suggest removing the keys
from the ssh-agent after use.
* *\<username\>* is *Administrator* (AWS) or *capi* (Azure)
Expand Down
4 changes: 2 additions & 2 deletions hack/community/csv/description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ version of OKD/OCP you are using. This CSV is meant for OKD/OCP COMMUNITY_VERSIO
## Documentation
### Introduction
The Windows Machine Config Operator configures Windows instances into nodes, enabling Windows container workloads
to be ran within OKD/OCP clusters. Windows instances can be added either by creating a [MachineSet](https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/windows_container_support_for_openshift/creating-windows-machine-sets#creating-windows-machineset-aws),
or by specifying existing instances through a [ConfigMap](https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/windows_container_support_for_openshift/byoh-windows-instance).
to be ran within OKD/OCP clusters. Windows instances can be added either by creating a [MachineSet](https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/windows_container_support_for_openshift/creating-windows-machine-sets#creating-windows-machineset-aws),
or by specifying existing instances through a [ConfigMap](https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/windows_container_support_for_openshift/byoh-windows-instance).
The operator will do all the necessary steps to configure the instance so that it can join the cluster as a worker node.
### Pre-requisites
- [Cluster and OS pre-requisites](https://github.com/openshift/windows-machine-config-operator/blob/COMMUNITY_VERSION/docs/wmco-prerequisites.md)
Expand Down