MGMT-20611: Make KMM operator URL dynamic

[celdrake]

Summary by CodeRabbit

• New Features
  • Documentation links for the Kernel Module Management (KMM) operator are now dynamically generated based on the selected OpenShift version, ensuring users are directed to the correct version-specific documentation.
• Improvements
  • Operator descriptions now better align with other operators by supporting version-aware documentation links.

[openshift-ci-robot]

@celdrake: This pull request references MGMT-20611 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.20.0" version, but no target version was set.

Details

In 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.

[coderabbitai]

Walkthrough

The changes update the Kernel Module Management (KMM) operator specification to use a dynamic documentation link that adjusts based on the OpenShift version. This involves replacing a static constant with a version-aware function for generating documentation URLs and updating the relevant type signatures.

Changes

File(s)	Change Summary
libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx	Replaced static KMM documentation link with dynamic link via getKmmDocsLink(openshiftVersion). Updated the Description prop to accept openshiftVersion.
libs/ui-lib/lib/common/config/docs_links.ts	Removed static KMM_LINK export and introduced getKmmDocsLink function to generate version-specific URLs.

Sequence Diagram(s)

sequenceDiagram
    participant UI as UI Component
    participant OperatorSpecs as Operator Specs
    participant DocsLinks as Docs Links Config

    UI->>OperatorSpecs: Render KMM operator description (with openshiftVersion)
    OperatorSpecs->>DocsLinks: getKmmDocsLink(openshiftVersion)
    DocsLinks-->>OperatorSpecs: Return version-specific documentation URL
    OperatorSpecs-->>UI: Render ExternalLink with dynamic URL

Loading

Possibly related PRs

• openshift-assisted/assisted-installer-ui#2944: Both PRs modify the Description property of an operator spec in operatorSpecs.tsx to accept an openshiftVersion prop and replace a static documentation link with a dynamic version-aware link generator imported from the config.

Suggested labels

lgtm, approved, size/XS

Suggested reviewers

• ammont82
• ElayAharoni

Poem

A hop and a jump, a version-aware leap,
Now KMM docs are no longer asleep.
With links that adapt to OpenShift’s tune,
The rabbits rejoice, and none too soon!
Dynamic URLs, a clever new trick—
For every release, just one simple click!
🐇✨

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx

Oops! 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.ts

Oops! 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 details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 795dc6d and 5dcd988.

📒 Files selected for processing (2)

• libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx (2 hunks)
• libs/ui-lib/lib/common/config/docs_links.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx (1)

libs/ui-lib/lib/common/config/docs_links.ts (1)

• getKmmDocsLink (93-96)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: format
• GitHub Check: tests
• GitHub Check: lint
• GitHub Check: unit-tests
• GitHub Check: translation-files
• GitHub Check: circular-deps

🔇 Additional comments (3)

libs/ui-lib/lib/common/config/docs_links.ts (1)

93-97: Consider edge-case validation for future OCP versions

getKmmDocsLink() simply interpolates the numeric value returned by getShortOpenshiftVersion.
If/when OCP reaches a minor release ≥ 20 (e.g. 4.20), the numeric representation becomes 4.2 once converted to Number(...), which would generate a broken URL (…/4.2/html/…). The same silent truncation also happens with patch releases such as 4.18.10 ➜ 4.18.

Either keep the version as a string or round to two minor digits explicitly to avoid accidental shortening:

-export const getKmmDocsLink = (ocpVersion?: string) =>
-  `https://docs.redhat.com/en/documentation/openshift_container_platform/${getShortOpenshiftVersion(
-    ocpVersion,
-  )}/html/specialized_hardware_and_driver_enablement/kernel-module-management-operator`;
+export const getKmmDocsLink = (ocpVersion?: string) => {
+  const version = getShortOpenshiftVersion(ocpVersion).toFixed(2); // => '4.20'
+  return `https://docs.redhat.com/en/documentation/openshift_container_platform/${version
+    .replace(/\.?0+$/, '') /* strip trailing .00 */}/html/specialized_hardware_and_driver_enablement/kernel-module-management-operator`;
+}

This preserves 4.18, 4.20, etc. without risking 4.2.

libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx (2)

30-35: Missing barrel re-export may break the import

getKmmDocsLink is imported from ../../config, but only defined in docs_links.ts. Ensure libs/ui-lib/lib/common/config/index.ts re-exports the new symbol; otherwise the build will fail with “export not found”.

---

150-154: Prop plumbing check – is openshiftVersion actually propagated?

The new description expects an openshiftVersion prop, yet upstream callers previously rendered <Description /> with no parameters.
Please confirm all <Description> usages now supply openshiftVersion (e.g. via cluster data) to avoid the link reverting to the default docs version.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[openshift-ci-robot]

@celdrake: This pull request references MGMT-20611 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.20.0" version, but no target version was set.

Details

In response to this:

Summary by CodeRabbit

• New Features
• Documentation links for the Kernel Module Management (KMM) operator are now dynamically generated based on the selected OpenShift version, ensuring users are directed to the correct version-specific documentation.
• Improvements
• Operator descriptions now better align with other operators by supporting version-aware documentation links.

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.

[openshift-ci]

[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

Details

Needs approval from an approver in each of these files:

• OWNERS [ammont82,celdrake]

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

[ammont82]

/lgtm