MGMT-20520: Change learn more link for Kube Descheduler operator

[ammont82]

Related to https://issues.redhat.com/browse/MGMT-20520

The Learn more link for the Kube Descheduler Operator is incorrect. Needs to point to https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/nodes/controlling-pod-placement-onto-nodes-scheduling#additional-resources-3

Summary by CodeRabbit

• New Features
  • The Kube Descheduler operator's description now provides a version-specific documentation link based on your OpenShift version.

[openshift-ci-robot]

@ammont82: This pull request references MGMT-20520 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.19.0" version, but no target version was set.

Details

In response to this:

Related to https://issues.redhat.com/browse/MGMT-20520

The Learn more link for the Kube Descheduler Operator is incorrect. Needs to point to https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/nodes/controlling-pod-placement-onto-nodes-scheduling#additional-resources-3

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 change updates the Description property of the Kube Descheduler operator specification in the getOperatorSpecs function. The Description component now accepts an optional openshiftVersion prop and uses it to generate a version-specific documentation link via the getKubeDeschedulerLink function. The import statement is also updated to include this new function from the config module. This adjustment allows the description to dynamically display a documentation link tailored to the OpenShift version.

Changes

File(s)	Change Summary
libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx	Updated the Kube Descheduler Description to accept an openshiftVersion prop and use getKubeDeschedulerLink. Adjusted import statements accordingly.

Suggested labels

lgtm, approved, size/XS

Suggested reviewers

• celdrake

Poem

In the warren of code, a link hops anew,
Now version-aware, with each doc it will cue.
The Descheduler’s tale, once static and plain,
Now jumps to the docs for each OpenShift train.
🐇✨
Hooray for the change, so small yet so neat—
A dynamic new link for a rabbit’s quick feet!

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.

---

📜 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 4bc6a50 and 3cfbc0d.

📒 Files selected for processing (1)

• libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx (2 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)

• getKubeDeschedulerLink (120-123)

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

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

🔇 Additional comments (2)

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

33-33: Import looks good.

The addition of getKubeDeschedulerLink import is correctly placed in alphabetical order, maintaining code style consistency.

---

158-162: Correctly implemented version-specific documentation link.

The update properly modifies the Description component to accept an openshiftVersion parameter and uses it to generate a version-specific documentation link. This implementation follows the same pattern used by other operators in this file, ensuring consistency throughout the codebase.

✨ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ammont82, rawagner

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,rawagner]

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

[openshift-ci-robot]

@ammont82: This pull request references MGMT-20520 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.19.0" version, but no target version was set.

Details

In response to this:

Related to https://issues.redhat.com/browse/MGMT-20520

The Learn more link for the Kube Descheduler Operator is incorrect. Needs to point to https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/nodes/controlling-pod-placement-onto-nodes-scheduling#additional-resources-3

Summary by CodeRabbit

• New Features
• The Kube Descheduler operator's description now provides a version-specific documentation link based on your OpenShift version.

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.