OpenShift docs for 4.19 are already available#3032
Conversation
|
""" WalkthroughThe changes update documentation link constants and functions to use new Red Hat documentation domains, updated versions, and revised URL structures. The Service Mesh operator spec's description logic is simplified by removing the OpenShift version parameter, reflecting the new static documentation link structure. Changes
Suggested labels
Suggested reviewers
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
libs/ui-lib/lib/common/components/operators/operatorSpecs.tsxOops! Something went wrong! :( ESLint: 8.57.1 ESLint couldn't find the config "@openshift-assisted/eslint-config" to extend from. Please check that the name of the config is correct. The config "@openshift-assisted/eslint-config" was referenced from the config file in "/libs/ui-lib/.eslintrc.cjs". If you still have problems, please stop by https://eslint.org/chat/help to chat with the team. libs/ui-lib/lib/common/config/docs_links.tsOops! Something went wrong! :( ESLint: 8.57.1 ESLint couldn't find the config "@openshift-assisted/eslint-config" to extend from. Please check that the name of the config is correct. The config "@openshift-assisted/eslint-config" was referenced from the config file in "/libs/ui-lib/.eslintrc.cjs". If you still have problems, please stop by https://eslint.org/chat/help to chat with the team. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms (6)
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
openshift-ci
bot
added
approved
|
@ammont82 Do you think it's worth creating a ticket so QE can verify all the links? |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
libs/ui-lib/lib/common/config/docs_links.ts (1)
167-172: Clean up unused variable in the conditional logic.The function correctly implements version-specific URL logic, but there's a minor code quality issue.
export const getLsoLink = (ocpVersion?: string) => { - const version = getDocsOpenshiftVersion(ocpVersion); return isMajorMinorVersionEqualOrGreater(ocpVersion, '4.19') ? `https://docs.redhat.com/container-platform/4.19/storage/persistent_storage/persistent_storage_local/ways-to-provision-local-storage.html` - : `https://docs.openshift.com/container-platform/${version}/storage/persistent_storage/persistent_storage_local/ways-to-provision-local-storage.html`; + : `https://docs.openshift.com/container-platform/${getDocsOpenshiftVersion(ocpVersion)}/storage/persistent_storage/persistent_storage_local/ways-to-provision-local-storage.html`; };
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx(1 hunks)libs/ui-lib/lib/common/config/docs_links.ts(3 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx (2)
libs/ui-lib/lib/common/components/operators/operatorDescriptions.tsx (1)
DESCRIPTION_SERVICEMESH(54-55)libs/ui-lib/lib/common/config/docs_links.ts (1)
getServiceMeshLink(194-195)
libs/ui-lib/lib/common/config/docs_links.ts (1)
libs/ui-lib/lib/common/utils.ts (1)
isMajorMinorVersionEqualOrGreater(138-143)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: tests
- GitHub Check: unit-tests
- GitHub Check: translation-files
- GitHub Check: circular-deps
- GitHub Check: format
- GitHub Check: lint
🔇 Additional comments (7)
libs/ui-lib/lib/common/config/docs_links.ts (6)
3-3: LGTM! Version constant updated correctly.The
LATEST_OPENSHIFT_DOCS_VERSIONconstant has been properly updated from '4.18' to '4.19', which aligns with the PR objective.
194-195: LGTM! Service Mesh function correctly simplified.The function has been appropriately simplified to return a fixed URL for Service Mesh 3.0 documentation, removing the version parameter dependency. This aligns with the changes in the operatorSpecs.tsx file.
180-182: Documentation path confirmedThe Node Feature Discovery operator documentation URL returns HTTP 200, so the updated
docs.redhat.com/.../html/.../psap-node-feature-discovery-operatorpath is correct. Approving these changes.
192-192: Verified: Pipelines operator docs link is correct
Version 1.18 is the latest GA release of the Red Hat OpenShift Pipelines Operator, and the URL at the location below accurately points to its documentation. No changes required.• File:
libs/ui-lib/lib/common/config/docs_links.ts
Line 192 –'https://docs.redhat.com/en/documentation/red_hat_openshift_pipelines/1.18/html/installing_and_configuring/installing-pipelines';
198-198: Approve: Updated Serverless operator documentation link to v1.36Version 1.36 is the current Red Hat OpenShift Serverless Operator release (as of July 4, 2025), so the documentation URL is correct and no further changes are needed.
175-177: Verify the fragment identifier in the Networking Operators docsOur automated check didn’t find the
#k8s-nmstate-about-the-k8s-nmstate-operatoranchor on the 4.19 Networking Operators page. Please manually confirm that this fragment ID exists (or update it to match the actual heading ID in the docs).• File: libs/ui-lib/lib/common/config/docs_links.ts
• Lines: 175–177
• URL under test:
https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/networking/networking-operators#k8s-nmstate-about-the-k8s-nmstate-operatorlibs/ui-lib/lib/common/components/operators/operatorSpecs.tsx (1)
288-293: LGTM! Service Mesh component correctly updated.The changes properly align with the simplified
getServiceMeshLinkfunction:
- Removed the unused
openshiftVersionparameter from the component props- Updated the function call to not pass any arguments
This maintains consistency with the changes in
docs_links.tsand correctly implements the new static documentation link approach for Service Mesh.
celdrake
force-pushed
the
available-openshift-4.19-docs
branch
from
4fb8af4 to
a77129e
Compare
celdrake
force-pushed
the
available-openshift-4.19-docs
branch
from
a77129e to
d92a70c
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ammont82, celdrake The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-merge-bot
bot
merged commit 485d2e6
into
openshift-assisted:master
2 participants
Made some changes to doc links since OpenShift 4.19 is now Generally Available:
When users choose OpenShift 4.19, the documentation links are for that version instead of 4.18
Service mesh operator:
The previous link was for the documentation of Service Mesh 1.x which is now unsupported, plus Service Mesh has now official docs separate from OpenShift docs. I modified the link to the documentation for the standalone docs of Service Mesh 3.x
Local Storage Operator:
There are no docs in docs.openshift.com for LSO for OpenShift 4.19. Modified to the correct documentation in docs.redhat.com
Nmstate operator: The old docs in docs.openshift.com don't have the equivalent for 4.19. The new link seems to work with quite old OCP versions.
Pipelines and Serverless operators: The versions we linked for these operators were pretty outdated. I updated the links to docs.redhat.com links and to their latest versions.
Summary by CodeRabbit
New Features
Bug Fixes