Skip to content

docs(catalog): fix wrong component-selection bullets#869

Merged
mchmarny merged 2 commits into
NVIDIA:mainfrom
faganihajizada:fix/component-catalog-selection-bullets
May 13, 2026
Merged

docs(catalog): fix wrong component-selection bullets#869
mchmarny merged 2 commits into
NVIDIA:mainfrom
faganihajizada:fix/component-catalog-selection-bullets

Conversation

@faganihajizada
Copy link
Copy Markdown
Member

Summary

Fix the "How Components Are Selected" bullets in docs/user/component-catalog.md: the existing "Intent-specific components" bullet listed three components that aren't actually intent-selected. Replace with the truly intent-selected ones and add a separate "Platform-specific components" bullet for the misclassified ones.

Motivation / Context

The current bullet at docs/user/component-catalog.md:42 reads:

Intent-specific components (kubeflow-trainer, dynamo-platform, kai-scheduler) are added based on workload intent.

All three names in that list are wrong:

  • kubeflow-trainer is pulled in by the platform-kubeflow mixin (recipes/mixins/platform-kubeflow.yaml line 21), which is referenced only by leaf overlays whose criteria include platform: kubeflow. So it's platform-selected, not intent-selected.
  • dynamo-platform is declared inline in 6 *-inference-dynamo overlays (e.g., h100-eks-ubuntu-inference-dynamo.yaml line 30: platform: dynamo). Also platform-selected.
  • kai-scheduler is in base.yaml line 89. It appears in every recipe regardless of intent — it's a base component.

The actually intent-selected components are kgateway and kgateway-crds, pulled in by the platform-inference mixin (recipes/mixins/platform-inference.yaml) which is wired into all *-inference overlays.

This is most likely a leftover from before ADR-005, when platform components lived inside intent-tied overlays directly.

Fixes: N/A
Related: N/A

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Refactoring (no functional changes)
  • Build/CI/tooling

Component(s) Affected

  • CLI (cmd/aicr, pkg/cli)
  • API server (cmd/aicrd, pkg/api, pkg/server)
  • Recipe engine / data (pkg/recipe)
  • Bundlers (pkg/bundler, pkg/component/*)
  • Collectors / snapshotter (pkg/collector, pkg/snapshotter)
  • Validator (pkg/validator)
  • Core libraries (pkg/errors, pkg/k8s)
  • Docs/examples (docs/, examples/)
  • Other: ____________

No code, no test, no other file changes.

Testing

make lint   # full lint pass: lint-go + lint-yaml + license + check-agents-sync + check-docs-sidebar + MDX safety

Result: PASS — Completed Go and YAML lints and ensured license headers.

No tests to add (doc-only change). The schema/recipe tests in pkg/recipe/yaml_test.go already validate the actual matcher behavior; this fix only updates the human-readable description of that behavior.

Risk Assessment

  • Low — Isolated change, well-tested, easy to revert
  • Medium — Touches multiple components or has broader impact
  • High — Breaking change, affects critical paths, or complex rollout

Rationale: Doc-only change to a single bullet list in a user-facing reference page. No code paths affected. Reversible by git revert.

Rollout notes: N/A — additive doc fix.

Checklist

  • Tests pass locally (make test with -race) — N/A (doc-only)
  • Linter passes (make lint)
  • I did not skip/disable tests to make CI green
  • I added/updated tests for new functionality — N/A (doc-only)
  • I updated docs if user-facing behavior changed
  • Changes follow existing patterns in the codebase
  • Commits are cryptographically signed (git commit -S)

The "Intent-specific components" bullet listed kubeflow-trainer,
dynamo-platform, and kai-scheduler — none of which are intent-selected:
kubeflow-trainer is pulled in by the platform-kubeflow mixin (criteria
platform=kubeflow), dynamo-platform is declared inline in *-inference-
dynamo overlays (criteria platform=dynamo), and kai-scheduler is a base
component (recipes/overlays/base.yaml line 89 — appears in every
recipe).

Replace with the actually intent-selected components (kgateway,
kgateway-crds via the platform-inference mixin) and add a separate
"Platform-specific components" bullet for kubeflow-trainer and
dynamo-platform.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 13, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR updates the component selection documentation in the user guide. The "Intent-specific components" section now specifies that kgateway and kgateway-crds are added based on workload intent, using inference recipes as an example. This replaces a previous list that included kubeflow-trainer, dynamo-platform, and kai-scheduler.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: fixing incorrect component-selection bullets in the documentation.
Description check ✅ Passed The description is directly related to the changeset, providing detailed context about which components were incorrectly classified and how they were corrected.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/user/component-catalog.md`:
- Around line 43-44: Add a usage example for the --platform flag similar to the
existing --intent example: insert a sample command (e.g., "aicr recipe --service
eks --accelerator h100 --os ubuntu --intent training --platform kubeflow -o
recipe.yaml") immediately after the --intent example and add a short clarifying
sentence that "platform" refers to the training/inference framework (valid
values: kubeflow, dynamo, etc.), so readers understand the expected flag values
and purpose.
🪄 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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 873cbbed-2de1-4c98-a9a8-818f9ff1642e

📥 Commits

Reviewing files that changed from the base of the PR and between 139ed70 and 6ed6041.

📒 Files selected for processing (1)
  • docs/user/component-catalog.md

Comment thread docs/user/component-catalog.md
@mchmarny mchmarny merged commit 4df96db into NVIDIA:main May 13, 2026
34 checks passed
@faganihajizada faganihajizada deleted the fix/component-catalog-selection-bullets branch May 13, 2026 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants