[DRAFT/WIP] Hardware profiles migration info

[obrown1205]

Description

How Has This Been Tested?

Merge criteria:

• The commits are squashed in a cohesive manner and have meaningful messages.
• Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
• The developer has manually tested the changes and verified that the changes work

Summary by CodeRabbit

Documentation

• Updated hardware profile configuration documentation with explicit instructions for required settings, improved guidance on dashboard navigation and hardware profile options, and enhanced references to related UI components for workbench image configuration.

[coderabbitai]

Walkthrough

Documentation updates to clarify hardware profiles configuration in workbench images. Reworded guidance to specify the OdhDashboardConfig CR location, added explicit instructions for the disableHardwareProfiles key, and adjusted spacing.

Changes

Cohort / File(s)	Change Summary
Documentation clarification modules/configuring-a-recommended-accelerator-for-workbench-images.adoc	Reworded hardware profiles configuration guidance to specify OdhDashboardConfig CR in redhat-odh-applications namespace within {openshift-platform}; added explicit instruction to manually add disableHardwareProfiles key and set to false if not present; broadened references to include dashboard navigation and UI components; minor spacing adjustments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.
Title Check	❓ Inconclusive	The pull request title "[DRAFT/WIP] Hardware profiles migration info" does reference hardware profiles, which is the correct topic of the changes in the documentation file. However, the term "migration info" is vague and does not clearly convey the actual nature of the changes—which are reworded configuration guidance and explicit instructions for the disableHardwareProfiles key. The "[DRAFT/WIP]" prefix combined with incomplete PR description sections in the objectives further suggests this is preliminary work. While the title touches on the right subject area, it lacks clarity about what specifically was modified or updated.	Consider revising the title to be more specific about the actual changes, such as "Update hardware profiles configuration guidance in documentation" or "Document OdhDashboardConfig location for hardware profiles," which would more accurately describe the reworded guidance and new explicit instructions. Additionally, remove the "[DRAFT/WIP]" prefix once the PR is ready for review and ensure all sections of the PR description are filled out with substantive content and completed checklist items.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 18410df and 3908e96.

📒 Files selected for processing (1)

• modules/configuring-a-recommended-accelerator-for-workbench-images.adoc (1 hunks)

🔇 Additional comments (1)

modules/configuring-a-recommended-accelerator-for-workbench-images.adoc (1)

36-40: Clarify implementation steps and verify namespace applicability.

The updated guidance correctly specifies the OdhDashboardConfig CR location, but the migration instructions lack important implementation details:

1. How to access/edit the CR: The text references setting the disableHardwareProfiles value but doesn't explain whether users should edit it via kubectl, the OpenShift Console, or another method.
2. Namespace scope uncertainty: The guidance specifies redhat-odh-applications namespace unconditionally. However, given that the document uses conditional directives (ifdef::upstream[] / ifndef::upstream[]), verify whether this namespace is correct for both upstream and downstream deployments. If it differs, add appropriate conditionals.
3. Missing YAML context: Users might benefit from a brief example showing the structure of the disableHardwareProfiles configuration in the CR (e.g., dashboardConfig.disableHardwareProfiles: false).

Consider adding one of the following:

• A reference to how to edit custom resources in your deployment (link to OpenShift/upstream docs).
• A brief inline example or note clarifying the YAML structure or CLI command for verification.

If the namespace or procedure differs between upstream and downstream, wrap the guidance with appropriate conditionals (e.g., ifdef::upstream[] / ifndef::upstream[]).

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}