Skip to content

docs(testgrid): public TestGrid page + Fern nav (TG6)#1463

Merged
mchmarny merged 1 commit into
mainfrom
docs/testgrid-tg6
Jun 24, 2026
Merged

docs(testgrid): public TestGrid page + Fern nav (TG6)#1463
mchmarny merged 1 commit into
mainfrom
docs/testgrid-tg6

Conversation

@mchmarny

@mchmarny mchmarny commented Jun 24, 2026

Copy link
Copy Markdown
Member

Summary

Adds the public-facing AICR TestGrid docs page (docs/user/testgrid.md) and registers it in the Fern nav, completing the user-facing deliverable for TG6. The CSP-first taxonomy, the recipe→coordinate mapping (pkg/recipe.CoordinateFor), the pinned column-metadata schema, the ADR-009 reconciliation, and the #1224 cross-link contract already shipped in ADR-012; this PR presents that contract for end users.

Motivation / Context

TG6 asks for the canonical taxonomy/mapping/metadata schema to be documented and a public TestGrid page published. The engineering (shared Go function + golden test) and the design ADR-012 already landed; the remaining gap was the user docs page + nav registration. ADR-012's "Out of scope" note (page deferred to TG4a) is updated to reflect that the page now exists, with ADR-012 remaining the internal source of truth.

Fixes: #1272
Related: #1224, #1263

Type of Change

  • Documentation update

Component(s) Affected

  • Docs/examples (docs/, examples/)

Implementation Notes

  • New page covers: what the TestGrid is, CSP-first navigation (group/dashboard/tab/row/column), the coordinate / stable URL form, the K8s-version-in-column facet, the provenance/signer/source metadata columns (community vs UAT), and how it coexists with the offline Recipe Health and Coverage matrices (link-only Evidence cross-link, never duplication).
  • Registered under User Guide in docs/index.yml (Latest nav). Released-version navs under fern/versions/*.yml are publish-time snapshots and are intentionally not edited for an unreleased page.
  • No Go changes — the shared mapping function and its golden test already exist.

Testing

make lint   # check-docs-filenames + check-docs-mdx
  • check-docs-filenames: OK
  • check-docs-mdx: OK
  • All intra-doc and cross-doc links verified to resolve (lychee anchor check runs in fern-docs-ci).

Risk Assessment

  • Low — Docs-only, additive, easy to revert.

Rollout notes: N/A

Checklist

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

@mchmarny mchmarny requested a review from a team as a code owner June 24, 2026 22:02
@mchmarny mchmarny added area/docs theme/validation Constraint evaluation, health checks, and conformance evidence labels Jun 24, 2026
@mchmarny mchmarny self-assigned this Jun 24, 2026
@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

Coverage data unavailable for this run. This can happen if the qualification workflow was cancelled or failed before generating coverage artifacts.

@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://nvidia-preview-docs-testgrid-tg6.docs.buildwithfern.com/aicr

@mchmarny mchmarny enabled auto-merge (squash) June 24, 2026 22:06
@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 5cf6edcc-4712-4bb1-99f0-3fa1acd11a80

📥 Commits

Reviewing files that changed from the base of the PR and between 4e6824e and 767c3e7.

📒 Files selected for processing (3)
  • docs/design/012-recipe-coordinate-mapping.md
  • docs/index.yml
  • docs/user/testgrid.md
📝 Walkthrough

Walkthrough

Updated the TestGrid documentation by adding a new user guide page that describes the coordinate model, provenance metadata, Kubernetes version as a column facet, and the relationship to Recipe Health. The ADR scope text was revised to state that the user page is the end-user contract and the ADR is the internal source of truth. The documentation navigation was also updated to link the new TestGrid page.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • NVIDIA/aicr#1132: Covers the Recipe Health side of the same TestGrid/Recipe Health contract and the separation between offline and live validation surfaces.
  • NVIDIA/aicr#1409: Related to the coordinate-mapping ADR and the documented TestGrid coordinate semantics used by this page.

Suggested labels

size/S

Suggested reviewers

  • njhensley
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: a public TestGrid docs page plus Fern navigation registration.
Description check ✅ Passed The description is directly about the TestGrid docs page, nav update, and ADR reconciliation described by the PR.
Linked Issues check ✅ Passed The new TestGrid page and nav update cover the #1272 docs deliverable: taxonomy, coordinate mapping, metadata schema, and Recipe Health cross-link contract.
Out of Scope Changes check ✅ Passed All changes are docs-only and directly support the TestGrid page, nav registration, and ADR scope clarification; nothing unrelated stands out.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/testgrid-tg6

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

@mchmarny mchmarny merged commit 596ba97 into main Jun 24, 2026
28 of 29 checks passed
@mchmarny mchmarny deleted the docs/testgrid-tg6 branch June 24, 2026 22:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@njhensley njhensley njhensley approved these changes

Assignees

@mchmarny mchmarny

Labels

area/docs size/M theme/validation Constraint evaluation, health checks, and conformance evidence

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

TG6 — IA/taxonomy spec + shared mapping function + public docs + #1224 reconciliation/cross-link contract

2 participants

@mchmarny @njhensley