docs: fix audit findings (OCP service, OpenShift link, ADR-014, evidence routing) by yuanchen8911 · Pull Request #1527 · NVIDIA/aicr

yuanchen8911 · 2026-06-29T15:47:15Z

Summary

Fixes six documentation findings from a docs audit: a missing service value, an unlinked guide, an ADR numbering collision, and routing/glossary gaps in the new evidence-pipeline docs.

Motivation / Context

A sweep of docs/** against the code sources of truth surfaced concrete drift and discoverability gaps. None are behavioral; all are doc-only corrections.

Fixes: N/A
Related: N/A

Type of Change

Documentation update

Component(s) Affected

Docs/examples (docs/, examples/)

Implementation Notes

README — added OCP to the supported Services table. pkg/recipe/criteria.go defines CriteriaServiceOCP = "ocp" and ADR-014 documents OpenShift as implemented, but the table omitted it.
integrator/index + docs/index.yml — linked the existing openshift.md guide from the integrator hub, and added it to the Fern site navigation (docs/index.yml) so it is reachable on docs.nvidia.com, not just in the GitHub tree. Also added the two other integrator pages that were missing from the site nav (talos-integration.md, supply-chain-verification.md) — same orphaned-on-site problem.
design ADRs — renumbered the OpenShift ADR 013 → 014 to resolve a collision with 013-aicr-run-domain-migration.md (ADR-011 cross-links ADR-013, pointing at the domain-migration file). Also dropped a stray leading + left on its Status line.
contributor/index — added "Where to Next" routes to evidence-publishing.md, evidence-ingest.md, and evidence-dashboard-publish.md (the latter two were new on main and unreferenced).
evidence-ingest / evidence-dashboard-publish — added a GPn pipeline stage map (GP1–GP5) so the workstream labels used throughout are defined.

Findings deliberately not changed: the evidence-dashboard-publish.md "loader schema not yet reconciled" note is accurate (allowlist.yaml uses source/identityPattern and rejects identity:, while pkg/corroborate still carries Identity); ####-level anchor links resolve fine on GitHub/Fern; CLI --accelerator/--platform examples use a consistent e.g. <subset> style shared by all filter flags.

Testing

# Doc-only change — scoped checks in lieu of full `make qualify`:
# - verified every touched link target exists (openshift.md, the three evidence docs)
# - confirmed no remaining duplicate `# ADR-013` heading after the renumber
# - no inbound links referenced the old 013-ocp-helm.md filename

Full make qualify skipped: no Go/YAML/CI changes, so tests, e2e, and Go lint cannot regress. Note lychee anchor checking runs separately in CI on docs/** PRs.

Risk Assessment

Low — Isolated doc-only change, easy to revert.

Rollout notes: N/A

Checklist

I updated docs if user-facing behavior changed
Changes follow existing patterns in the codebase
Commits are cryptographically signed (git commit -S)

github-actions · 2026-06-29T15:48:16Z

🌿 Preview your docs: https://nvidia-preview-docs-audit-fixes.docs.buildwithfern.com/aicr

coderabbitai · 2026-06-29T15:50:47Z

📝 Walkthrough

Walkthrough

Documentation-only changes update the evidence pipeline docs with GP1–GP5 stage labels and a GPn cross-link, add evidence-related links to the contributor index, add OpenShift Deployment entries to the integrator docs and navigation, and correct the ADR-014 header and status formatting. README.md also receives a formatting-only table edit.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main documentation fixes, including OpenShift, ADR numbering, and evidence routing.
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.
Description check	✅ Passed	The description accurately matches the documentation-only changes across README, OpenShift docs, ADR renumbering, and evidence-pipeline navigation.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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

coderabbitai

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/contributor/evidence-ingest.md`:
- Around line 11-15: The paragraph in evidence-ingest.md should be reflowed so
`#1400` stays on the same line as the preceding text instead of starting a new
line that markdownlint treats as a heading. Update the sentence that describes
the `GPn` labels and the epic reference together, keeping the issue reference
inline while preserving the existing meaning.

🪄 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: dcebcf55-0acc-49ea-a944-724659e0bad6

📥 Commits

Reviewing files that changed from the base of the PR and between 4fc0e60 and a1b40bb.

📒 Files selected for processing (6)

README.md
docs/contributor/evidence-dashboard-publish.md
docs/contributor/evidence-ingest.md
docs/contributor/index.md
docs/design/014-ocp-helm.md
docs/integrator/index.md

coderabbitai · 2026-06-29T15:50:50Z

+The `GPn` labels name stages of the evidence-corroboration pipeline (epic
+#1400): **GP1** signer-allowlist management (`recipes/evidence/allowlist.yaml`),
+**GP2** ingest/verify (this doc), **GP3** dashboard infrastructure
+(`infra/evidence-dashboard`), **GP4** consensus/corroboration
+(`pkg/corroborate`), and **GP5** dashboard publish.


📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Fix the line wrap around #1400.

The new paragraph starts a line with #1400, which markdownlint reads as a malformed heading. Reflow this sentence so the issue reference stays on the same line as the preceding text.

♻️ Proposed fix

-The `GPn` labels name stages of the evidence-corroboration pipeline (epic -#1400): **GP1** signer-allowlist management (`recipes/evidence/allowlist.yaml`), **GP2** ingest/verify (this doc), **GP3** dashboard infrastructure (`infra/evidence-dashboard`), **GP4** consensus/corroboration (`pkg/corroborate`), and **GP5** dashboard publish. +The `GPn` labels name stages of the evidence-corroboration pipeline (epic `#1400`): **GP1** signer-allowlist management (`recipes/evidence/allowlist.yaml`), **GP2** ingest/verify (this doc), **GP3** dashboard infrastructure (`infra/evidence-dashboard`), **GP4** consensus/corroboration (`pkg/corroborate`), and **GP5** dashboard publish.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

The `GPn` labels name stages of the evidence-corroboration pipeline (epic

#1400): **GP1** signer-allowlist management (`recipes/evidence/allowlist.yaml`),

**GP2** ingest/verify (this doc), **GP3** dashboard infrastructure

(`infra/evidence-dashboard`), **GP4** consensus/corroboration

(`pkg/corroborate`), and **GP5** dashboard publish.

The `GPn` labels name stages of the evidence-corroboration pipeline (epic `#1400`): **GP1** signer-allowlist management (`recipes/evidence/allowlist.yaml`), **GP2** ingest/verify (this doc), **GP3** dashboard infrastructure (`infra/evidence-dashboard`), **GP4** consensus/corroboration (`pkg/corroborate`), and **GP5** dashboard publish.

🧰 Tools

🪛 markdownlint-cli2 (0.22.1)

[warning] 12-12: No space after hash on atx style heading

(MD018, no-missing-space-atx)

🤖 Prompt for 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. In `@docs/contributor/evidence-ingest.md` around lines 11 - 15, The paragraph in evidence-ingest.md should be reflowed so `#1400` stays on the same line as the preceding text instead of starting a new line that markdownlint treats as a heading. Update the sentence that describes the `GPn` labels and the epic reference together, keeping the issue reference inline while preserving the existing meaning.

Source: Linters/SAST tools

…nce routing) - README: add OCP to the supported Services list (criteria.go defines CriteriaServiceOCP but the table omitted it) - integrator/index: link the existing openshift.md guide (was undiscoverable) - design: renumber the OpenShift ADR 013 -> 014 to resolve a numbering collision with 013-aicr-run-domain-migration.md (ADR-011 links to 013); drop a stray leading '+' on the Status line - contributor/index: route to evidence-publishing/ingest/dashboard-publish from 'Where to Next' - evidence-ingest/dashboard-publish: add a GPn pipeline stage map so the GP1-GP5 labels are defined Signed-off-by: Yuan Chen <[email protected]>

yuanchen8911 · 2026-06-29T16:37:45Z

Combined into #1528, which now contains these fixes plus the broader docs-correctness sweep.

yuanchen8911 added theme/community Contributor onboarding, docs, and external engagement area/docs labels Jun 29, 2026

github-actions Bot added the size/S label Jun 29, 2026

coderabbitai Bot reviewed Jun 29, 2026

View reviewed changes

yuanchen8911 force-pushed the docs/audit-fixes branch from a1b40bb to da0a462 Compare June 29, 2026 15:54

mchmarny assigned yuanchen8911 Jun 29, 2026

yuanchen8911 force-pushed the docs/audit-fixes branch from da0a462 to a1b624a Compare June 29, 2026 15:55

yuanchen8911 mentioned this pull request Jun 29, 2026

docs: full correctness audit — fix drift across docs, demos, ADRs #1528

Merged

10 tasks

yuanchen8911 closed this Jun 29, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: fix audit findings (OCP service, OpenShift link, ADR-014, evidence routing)#1527

docs: fix audit findings (OCP service, OpenShift link, ADR-014, evidence routing)#1527
yuanchen8911 wants to merge 1 commit into
NVIDIA:mainfrom
yuanchen8911:docs/audit-fixes

yuanchen8911 commented Jun 29, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 29, 2026

Uh oh!

coderabbitai Bot commented Jun 29, 2026 •

edited

Loading

Walkthrough

Estimated code review effort

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Jun 29, 2026

Uh oh!

yuanchen8911 commented Jun 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

yuanchen8911 commented Jun 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Motivation / Context

Type of Change

Component(s) Affected

Implementation Notes

Testing

Risk Assessment

Checklist

Uh oh!

github-actions Bot commented Jun 29, 2026

Uh oh!

coderabbitai Bot commented Jun 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Estimated code review effort

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jun 29, 2026

Choose a reason for hiding this comment

Uh oh!

yuanchen8911 commented Jun 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

yuanchen8911 commented Jun 29, 2026 •

edited

Loading

coderabbitai Bot commented Jun 29, 2026 •

edited

Loading