docs(catalog): fix wrong component-selection bullets#869
Conversation
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.
📝 WalkthroughWalkthroughThis PR updates the component selection documentation in the user guide. The "Intent-specific components" section now specifies that Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
docs/user/component-catalog.md
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:42reads:All three names in that list are wrong:
kubeflow-traineris pulled in by theplatform-kubeflowmixin (recipes/mixins/platform-kubeflow.yaml line 21), which is referenced only by leaf overlays whose criteria includeplatform: kubeflow. So it's platform-selected, not intent-selected.dynamo-platformis declared inline in 6*-inference-dynamooverlays (e.g., h100-eks-ubuntu-inference-dynamo.yaml line 30:platform: dynamo). Also platform-selected.kai-scheduleris in base.yaml line 89. It appears in every recipe regardless of intent — it's a base component.The actually intent-selected components are
kgatewayandkgateway-crds, pulled in by theplatform-inferencemixin (recipes/mixins/platform-inference.yaml) which is wired into all*-inferenceoverlays.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
Component(s) Affected
cmd/aicr,pkg/cli)cmd/aicrd,pkg/api,pkg/server)pkg/recipe)pkg/bundler,pkg/component/*)pkg/collector,pkg/snapshotter)pkg/validator)pkg/errors,pkg/k8s)docs/,examples/)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 safetyResult: 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.goalready validate the actual matcher behavior; this fix only updates the human-readable description of that behavior.Risk Assessment
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
make testwith-race) — N/A (doc-only)make lint)git commit -S)