Skip to content

docs(recipe): clarify recipe stewardship and composition - #3000

Merged
mchmarny merged 4 commits into
NVIDIA:mainfrom
framsouza:docs/recipe-stewardship-composition-2270
Oct 3, 2026
Merged

mchmarny merged 4 commits into
NVIDIA:mainfrom
framsouza:docs/recipe-stewardship-composition-2270

Conversation

@framsouza

Copy link
Copy Markdown
Contributor

Summary

Adds a short Recipe stewardship and composition note to the Recipe Development Guide's Overview, explaining that a resolved recipe is materialized from a composition graph rather than authored as one standalone, independently owned file.

Motivation / Context

Readers of the Recipe Development Guide can come away thinking a resolved recipe is a flat configuration artifact with a single owner (NCP vs. ISV vs. NVIDIA). It is not — it is materialized from a directed acyclic graph of registry defaults, overlays, mixins, configuration profiles, and optional external --data input.

The issue originally proposed a "Recipe ownership and provenance" note plus a separate FAQ entry. @mchmarny narrowed the scope in #2270 (comment) and the reporter agreed. This PR implements that narrowed scope:

  • One note, under the Overview — no FAQ entry, which would duplicate it (and the docs tree has no FAQ page).
  • Avoids describing the output as having "no owner". Ownership is collective at the project level: AICR maintainers are accountable for the catalog accepted into the project, and the AICR community collectively owns and evolves it.
  • States that metadata.appliedOverlays records resolution order and is deliberately not an ownership or per-field attribution ledger — resolution materializes the effective configuration rather than preserving authorship for every contributing value.
  • States that repository history identifies contributions to source files, which describes the layer, not the resolved recipe.

Fixes: #2270
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/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: ____________

Implementation Notes

Placement. The note lands as a ### subsection closing out ## Overview in docs/integrator/recipe-development.md, immediately after the existing "For query matching and overlay merging internals" pointer. A heading rather than a bold paragraph is correct per the repo's Documentation Style rule — it names a topic and runs past the ~8-content-line threshold — and it gives the note a stable anchor to link at. Heading text is sentence case, matching existing siblings in this file (### Inference performance constraints, ### Regional registry overrides).

Links. Three, each verified against a live heading:

Link Target
#configuration-profiles ### Configuration Profiles, same file
../contributor/recipe.md#observable-reciperesult-surfaces ## Observable RecipeResult Surfaces — where Metadata.AppliedOverlays is actually documented
GOVERNANCE.md#areas-of-ownership ## Areas of Ownership

GOVERNANCE.md is linked as an absolute https://github.com/NVIDIA/aicr/blob/main/... URL, per the existing convention for repo-root files — a relative path would escape the Fern docs root. The two in-docs links are relative.

Deliberately not linked: docs/contributor/maintaining.md → ### `maintainers:` Block Routing (Post PR-D). Its slug is ambiguous (backticks, colon, parentheses) and it has zero existing inbound links, so it is a broken-anchor risk.

No docs/index.yml change — the page is already registered, and the Fern nav lists pages only, not per-page anchors.

Terminology note: "ownership" is already load-bearing in this guide for the GPU-stack sense (which component owns the driver / device plugin). The new prose keeps its subject unmistakably the recipe.

Testing

# Docs gates (all pass)
make lint-yaml check-agents-sync check-docs-filenames check-docs-mdx check-docs-mdx-parse check-docs-yaml
#   OK: AGENTS.md is in sync with .claude/CLAUDE.md
#   OK: all doc filenames follow kebab-case convention
#   OK: all doc files are MDX-safe
#   OK: 62 doc file(s) parse as MDX
#   OK: 186 YAML block(s) in 111 Markdown file(s) parse successfully

# Link check — CI's exact invocation, across all of docs/
lychee --offline --no-progress 'docs/**/*.md'
#   1587 Total | 759 Unique | 894 OK | 0 Errors | 693 Excluded

# Link check — stricter than CI, with anchor/fragment resolution on the changed file
lychee --offline --no-progress --include-fragments 'docs/integrator/recipe-development.md'
#   67 Total | 57 Unique | 45 OK | 0 Errors | 22 Excluded

go vet ./...                 # clean
go test ./pkg/recipe/...     # ok (recipe, catalog, ocisource, oskind)

make qualify was not run locally. The dev box is missing 20 of the 26 pinned tools (golangci-lint, addlicense, goreleaser, grype, syft, chainsaw, …) and qualify additionally runs e2e against a Kind cluster, so both make lint and make license fail on missing binaries rather than on this change. No .go files are touched, so the mandatory per-package Go lint gate and the test-coverage gate do not apply; the checks this change could plausibly break are the docs gates and lychee, which are run above. Deferring to the merge gate for the remainder.

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

Documentation-only: 19 added lines in one file, no code, no behavior change.

Rollout notes: N/A

Checklist

  • Tests pass locally (make test with -race) — scoped to ./pkg/recipe/...; no Go changes in this PR
  • Linter passes (make lint) — docs gates pass; Go/license lint blocked on missing local tools, see Testing
  • I did not skip/disable tests to make CI green
  • I added/updated tests for new functionality — N/A, docs only
  • I updated docs if user-facing behavior changed
  • Changes follow existing patterns in the codebase
  • Commits are cryptographically signed (git commit -S)

Signed-off-by: framsouza <fram.souza14@gmail.com>
@copy-pr-bot

copy-pr-bot Bot commented Sep 30, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

⚙️ Run configuration

Configuration used: Repository: NVIDIA/aicr/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 9dbd7a06-ebb4-4ba7-b1a9-5de5f40c9504

📥 Commits

Reviewing files that changed from the base of the PR and between 78ce779 and 84d3f97.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: NVIDIA/aicr/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 4edc0d7b-4cdf-48c2-8f4f-dadf1c515bc0

📥 Commits

Reviewing files that changed from the base of the PR and between 8cc2c19 and c3c6a48.

📒 Files selected for processing (1)
  • docs/integrator/recipe-development.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.


📝 Walkthrough

Walkthrough

The Recipe Development Guide adds a section on recipe stewardship and composition. It explains that resolved recipes combine multiple configuration sources, describes community ownership and maintainer accountability, and clarifies what overlay metadata and repository history indicate about provenance.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Suggested reviewers: yuanchen8911

Merge Risk: ⚪ Minimal · up to c3c6a

This documentation change accurately clarifies recipe composition and provenance; no material merge risk remains.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The PR implements the coding requirement in #2270. It adds the “Recipe stewardship and composition” note to docs/integrator/recipe-development.md. The note explains composition from registry default…
Out of Scope Changes check ✅ Passed The reported change is limited to 19 documentation lines in docs/integrator/recipe-development.md. The content directly supports #2270 by clarifying recipe composition, stewardship, ownership, and p…
Title check ✅ Passed The title clearly and concisely describes the documentation change to clarify recipe stewardship and composition.
Description check ✅ Passed The description directly explains the documentation change, its motivation, scope, implementation details, and validation results.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


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

@framsouza
framsouza marked this pull request as ready for review September 30, 2026 14:43
@framsouza
framsouza requested a review from a team as a code owner September 30, 2026 14:43
@mchmarny

Copy link
Copy Markdown
Member

Congrats, @framsouza, this is the 3000th PR in AICR!

@github-actions

Copy link
Copy Markdown
Contributor

@mchmarny mchmarny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Approve: no findings against 78ce779.

@mchmarny
mchmarny merged commit c826c5a into NVIDIA:main Oct 3, 2026
2 of 3 checks passed
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.

[Docs]: Clarify recipe ownership model in documentation

2 participants