OCPBUGS-84324: Update outdated documentation links and references#16362
OCPBUGS-84324: Update outdated documentation links and references#16362fsgreco wants to merge 2 commits intoopenshift:mainfrom
Conversation
- Fix 404 links and redirects on README file - Fix outdated CI manifest reference to use main branch in README file Fixes https://issues.redhat.com/browse/OCPBUGS-84324
openshift-ci-robot
added
jira/valid-reference
|
@fsgreco: This pull request references Jira Issue OCPBUGS-84324, which is valid. The bug has been moved to the POST state. 3 validation(s) were run on this bug
The bug has been updated to refer to the pull request using the external bug tracker. DetailsIn response to this:
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. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: fsgreco The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
@fsgreco: This pull request references Jira Issue OCPBUGS-84324, which is valid. 3 validation(s) were run on this bug
DetailsIn response to this:
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. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: openshift/coderabbit/.coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughUpdates to documentation: Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 11 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (11 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Line 16: Update the backporting section that still says "master branch first"
to use "main" for consistency; replace the sentence with the suggested wording:
"Typically, bugs are fixed in the main branch first then backported to the
appropriate release branches." Locate the paragraph in the CONTRIBUTING document
that describes backporting and change the word "master" to "main" and adjust the
sentence to match the provided phrasing.
In `@README.md`:
- Line 41: Replace the current CRC GitHub link and wording in README.md that
says "You can also use CodeReady Containers" to reference Red Hat's official
OpenShift Local documentation instead; update the text to mention "Red Hat
OpenShift Local" (or "Red Hat's OpenShift Local") and replace the URL with
https://access.redhat.com/documentation/en-us/red_hat_openshift_local/ so the
doc points to the official Red Hat product docs rather than the upstream crc
project.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: 1a4a10df-1441-4a0d-a270-3eadc1c217d0
📒 Files selected for processing (3)
CONTRIBUTING.mdREADME.mdSTYLEGUIDE.md
📜 Review details
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:38.076Z
Learning: Make commits of logical units
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:38.076Z
Learning: Commit message subject line should describe what changed
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:38.076Z
Learning: Commit message body should describe why the change was made
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:38.076Z
Learning: Commits fixing Bugzilla bugs should include 'Bug <number>:' prefix in the first line and link to the bug in the commit body
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:38.076Z
Learning: Pull requests closing GitHub issues should include 'Closes #<issue_number>' in the pull request description
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:38.076Z
Learning: Fixes should be implemented in the master branch first, then backported to appropriate release branches (format: release-X.Y)
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:51.319Z
Learning: Dependencies should be pinned to an exact semver, sha, or git tag (eg, no ^)
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:51.319Z
Learning: Support the latest versions of Edge, Chrome, Safari, and Firefox browsers; do not support IE 11 and earlier
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:51.319Z
Learning: Use the console operator to install and manage the console in OpenShift 4.x clusters
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:51.319Z
Learning: The console proxies the Kubernetes API under /api/kubernetes and provides additional non-Kubernetes APIs
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:51.319Z
Learning: Frontend code lives in the frontend/ directory and uses node, yarn, and webpack to compile dependencies into bundles
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:51.319Z
Learning: Frontend bundles are not committed to git
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:51.319Z
Learning: Follow CONTRIBUTING.md for workflow and convention details
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:56:51.319Z
Learning: Follow STYLEGUIDE.md for file format and coding style guide
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:57:18.105Z
Learning: Use lowercase dash-separated names for all files (to avoid git issues with case-insensitive file systems). Exceptions are files with their own naming conventions (e.g., Dockerfile, Makefile, README)
Learnt from: CR
Repo: openshift/console
Timestamp: 2026-04-28T07:57:18.105Z
Learning: Plugin SDK Changes: Any updates to `console-dynamic-plugin-sdk` should aim to maintain backward compatibility. Use the `plugin-api-review` skill to vet changes for public API impact
🔇 Additional comments (5)
STYLEGUIDE.md (1)
36-36: LGTM – Protocol upgrade to HTTPS.The update from HTTP to HTTPS is appropriate and aligns with modern security practices.
README.md (4)
19-21: LGTM – Modernized dependency documentation links.The updates to Go and kubectl documentation URLs use current canonical endpoints. The expanded
jqdescription with the GitHub code search link is helpful and appears accurate.
25-25: LGTM – Consistent Go documentation URL update.This change aligns with the Go documentation modernization on line 19.
142-142: CRC documentation links verified as correct.Both links to
crc.dev/docs/networking/#setting-up-on-a-remote-serverandcrc.dev/docs/getting-started/#creating-openshift-presetresolve to valid sections in the CRC documentation and require no changes.
312-312: The CI manifest path is correct. The reference tohttps://github.com/openshift/release/blob/main/ci-operator/jobs/openshift/console/openshift-console-main-presubmits.yamlfollows standard OpenShift CI operator conventions and aligns with the master→main branch migration. This is consistent with similar repos in the release repository.
| [OpenShift Installer](https://mirror.openshift.com/pub/openshift-v4/clients/ocp/latest/). More information about installing OpenShift can be found at | ||
| <https://try.openshift.com/>. | ||
| You can also use [CodeReady Containers](https://github.com/code-ready/crc) | ||
| You can also use [CodeReady Containers](https://github.com/crc-org/crc) |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Is crc.dev the official documentation site for CodeReady Containers?
💡 Result:
No, crc.dev is not the official documentation site for CodeReady Containers. crc.dev hosts the documentation for CRC (CodeReady Containers), which is the open-source upstream project. CodeReady Containers was Red Hat's branded distribution of CRC, now rebranded to Red Hat OpenShift Local. The official Red Hat documentation for Red Hat OpenShift Local (successor to CodeReady Containers) is hosted on access.redhat.com, such as https://access.redhat.com/documentation/en-us/red_hat_openshift_local/2.5/html-single/getting_started_guide/index.
Citations:
- 1: https://crc.dev/docs/introducing/
- 2: https://crc.dev/
- 3: https://github.com/crc-org/crc
- 4: https://crc.dev/docs/installing/
- 5: https://crc.dev/docs/getting-started/
- 6: https://access.redhat.com/documentation/en-us/red_hat_openshift_local/2.5/html-single/getting_started_guide/index
- 7: https://access.redhat.com/documentation/en-us/red_hat_openshift_local/2.12/html/getting_started_guide/installation_gsg
- 8: https://developers.redhat.com/products/codeready-containers/overview
- 9: https://openshift.guide/getting-started/openshift-local.html
🏁 Script executed:
#!/bin/bash
# Get the README.md file around line 41 to see the context
cat -n README.md | head -60Repository: openshift/console
Length of output: 3232
Clarify the documentation target—crc.dev documents the upstream open-source CRC project, not Red Hat's CodeReady Containers product.
The link should point to Red Hat's official OpenShift Local documentation (the successor to CodeReady Containers), not the upstream CRC repository. For consistency with this being an official OpenShift Console repository and the product context, use the Red Hat documentation rather than either the GitHub repo or upstream project docs.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 41, Replace the current CRC GitHub link and wording in
README.md that says "You can also use CodeReady Containers" to reference Red
Hat's official OpenShift Local documentation instead; update the text to mention
"Red Hat OpenShift Local" (or "Red Hat's OpenShift Local") and replace the URL
with https://access.redhat.com/documentation/en-us/red_hat_openshift_local/ so
the doc points to the official Red Hat product docs rather than the upstream crc
project.
There was a problem hiding this comment.
This is a valid point; however, as long as I understand OpenShift Local still relies on CRC under the hood (and the installation guide on developers.redhat.com is not publicly accessible, unlike the CRC one), what do you think, @Leo6Leo?
- Coderabbit's url results in a 404, this is the correct one: https://developers.redhat.com/products/openshift-local
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
|
@fsgreco Coderabbit's comment makes sense to me, will take a look again after you've fixed it |
|
@fsgreco: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
3 participants
Jira bug: https://issues.redhat.com/browse/OCPBUGS-84324
Analysis / Root cause:
Some links in the project's main documentation files (README.md, CONTRIBUTING.md, STYLEGUIDE.md) are broken, redirecting, or outdated. These create a poor onboarding experience for new contributors and can lead to confusion when following setup instructions.
Additional info:
Redirects are not necessarily a 'not found' case per se, but they could eventually become invalid in the future; therefore, it is better to replace them with their current URLs if possible.
Reviewers and assignees:
Docs approver:
/assign @Leo6Leo
Summary by CodeRabbit