Skip to content

fix: update broken documentation URLs and add missing scheme - #435

Open
judexzhu wants to merge 1 commit into
openshift:masterfrom
judexzhu:fix-broken-documentation-urls
Open

judexzhu wants to merge 1 commit into
openshift:masterfrom
judexzhu:fix-broken-documentation-urls

Conversation

@judexzhu

@judexzhu judexzhu commented Sep 11, 2026

Copy link
Copy Markdown

What type of PR is this?

bug

What this PR does / why we need it:

Fixes 404 documentation links identified across service log templates:

  • OSD on Google Cloud: Red Hat documentation renamed openshift_dedicated_clusters_on_gcp to openshift_dedicated_clusters_on_google_cloud. Updated in:
    • osd/Multiple_OCPBUGs_install_failure.json
    • osd/OCPBUG_install_failure.json
    • osd/rosa_cluster_cannot_be_recovered.json
  • ROSA HCP: Documentation path updated from install_rosa_with_hcp_clusters to install_clusters. Updated in:
    • hcp/customer_cni_misconfiguration.json
    • hcp/hcp_aws_kms_permissions_issue.json (both description and doc_references, plus updated section anchor)
    • hcp/sts_operator_role_misconfigured.json (plus updated section anchors)
  • Missing Scheme: Added missing https:// prefix in osd/cluster_alerting_with_no_sre_access.json.

Which Jira/Github issue(s) this PR fixes:

N/A

Special notes for your reviewer:

All links verified via rhapi get-doc and make checklinks.

Pre-checks:

  • make validate passes
  • make checkseverity passes
  • make checklinks passes

Summary by CodeRabbit

  • Documentation
    • Updated ROSA Hosted Control Planes documentation links for cluster installation, KMS permissions, customer-managed networking, and operator configuration guidance.
    • Updated Google Cloud references to use current documentation paths and terminology.
    • Corrected a cluster alert documentation link to include the secure HTTPS scheme.
    • Updated cluster recovery guidance to reference the current OpenShift Dedicated Google Cloud documentation.

- Fix 404 documentation links for GCP OSD clusters where path slug changed from 'openshift_dedicated_clusters_on_gcp' to 'openshift_dedicated_clusters_on_google_cloud'
- Fix 404 documentation links for ROSA HCP where path changed from 'install_rosa_with_hcp_clusters' to 'install_clusters'
- Update anchor links in ROSA HCP templates to match current section IDs
- Add missing 'https://' scheme in cluster_alerting_with_no_sre_access.json
@openshift-ci
openshift-ci Bot requested review from bmeng and ravitri September 11, 2026 23:02
@openshift-ci

openshift-ci Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

Details Needs approval from an approver in each of these files:

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

@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 43057f53-0dff-49d6-8a79-22c4aab333ba

📥 Commits

Reviewing files that changed from the base of the PR and between 1ab1b14 and 100c497.

📒 Files selected for processing (7)
  • hcp/customer_cni_misconfiguration.json
  • hcp/hcp_aws_kms_permissions_issue.json
  • hcp/sts_operator_role_misconfigured.json
  • osd/Multiple_OCPBUGs_install_failure.json
  • osd/OCPBUG_install_failure.json
  • osd/cluster_alerting_with_no_sre_access.json
  • osd/rosa_cluster_cannot_be_recovered.json

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


Walkthrough

The changes update documentation references in HCP and OSD notification definitions. The updates use current installation paths, Google Cloud paths, relevant anchors, and fully qualified HTTPS URLs.

Changes

Documentation reference updates

Layer / File(s) Summary
HCP documentation references
hcp/customer_cni_misconfiguration.json, hcp/hcp_aws_kms_permissions_issue.json, hcp/sts_operator_role_misconfigured.json
Updated HCP installation paths, issue text, operator configuration anchor, and BYO OIDC reference.
OSD documentation references
osd/Multiple_OCPBUGs_install_failure.json, osd/OCPBUG_install_failure.json, osd/cluster_alerting_with_no_sre_access.json, osd/rosa_cluster_cannot_be_recovered.json
Updated Google Cloud documentation paths, cluster deletion references, and one URL to use HTTPS.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 100c4

This PR updates documentation links only, and the reviewed references are valid, so it is ready to merge.

🚥 Pre-merge checks | ✅ 15
✅ Passed checks (15 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main changes: updating broken documentation URLs and adding a missing URL scheme.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed PASS: The pull request changes only seven JSON service-log templates. The diff updates documentation URLs and one description URL. It adds no Ginkgo test files, test declarations, or test titles. No d…
Test Structure And Quality ✅ Passed PASS: The pull request changes only seven JSON service-log templates, with nine URL/documentation-line insertions and deletions. No changed file contains Ginkgo tests, and no Ginkgo test files or mark…
Microshift Test Compatibility ✅ Passed The check is not applicable. The pull request modifies only seven JSON service-log templates, and the authoritative diff contains only documentation URL changes. No Ginkgo e2e tests or test declaratio…
Single Node Openshift (Sno) Test Compatibility ✅ Passed PASS. The pull request changes only seven JSON service-log templates. The authoritative diff contains documentation URL updates only, and it adds no Ginkgo test files or constructs such as It(), Descr…
Topology-Aware Scheduling Compatibility ✅ Passed PASS: The pull request changes only seven JSON service-log templates. The diff updates documentation URLs and one embedded documentation link. It adds no deployment manifests, operator code, controlle…
Ote Binary Stdout Contract ✅ Passed PASS: The pull request changes only seven JSON data files. The diff contains documentation URL and anchor updates, including the added https:// scheme. It adds no process-level code, logging configu…
Ipv6 And Disconnected Network Test Compatibility ✅ Passed The custom check is not applicable. The pull request changes only seven JSON service-log templates, with documentation URL updates. The authoritative diff adds no Ginkgo tests or test source files, an…
No-Weak-Crypto ✅ Passed PASS. The pull request changes only documentation URLs and related text in seven JSON service-log templates. The authoritative diff introduces no MD5, SHA1, DES, 3DES, RC4, Blowfish, ECB mode, custom …
Container-Privileges ✅ Passed PASS: The pull request changes only seven service-log JSON files. The changes update documentation-reference URLs and do not add Kubernetes or container manifests, privilege fields, capabilities, host…
No-Sensitive-Data-In-Logs ✅ Passed PASS: The pull request changes only public Red Hat documentation URLs and related documentation text. The authoritative diff introduces no passwords, tokens, API keys, PII, session IDs, internal hostn…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@openshift-ci

openshift-ci Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

@judexzhu: 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant