Skip to content

docs: post-#254 follow-ups — KEP-4962 note + Doc-Impact table rows#278

Merged
dmitsh merged 2 commits into
NVIDIA:mainfrom
resker:docs/post-254-followups
Apr 19, 2026
Merged

docs: post-#254 follow-ups — KEP-4962 note + Doc-Impact table rows#278
dmitsh merged 2 commits into
NVIDIA:mainfrom
resker:docs/post-254-followups

Conversation

@resker
Copy link
Copy Markdown
Collaborator

@resker resker commented Apr 19, 2026

Description

Two small follow-ups that became unblocked by PR #254 (docs(reference): add authoritative node labels and annotations reference) merging to main earlier today. Both were previously documented as "pending #254 merge" in session notes; bundled here as a single, minimal PR.

1. KEP-4962 upstream-alignment note (docs/reference/node-labels.md)

Adds a short subsection under ## Labels covering KEP-4962: Standardizing the Representation of Cluster Network Topology (draft in PR #4965). The note establishes that:

  • KEP-4962 is pre-GA and still under upstream review.
  • Topograph's network.topology.nvidia.com/* keys predate any upstream standard and are presently vendor-scoped.
  • The KEP's framing allows vendor prefixes and standard topology.kubernetes.io/ keys to coexist, not replace one another.
  • If KEP-4962 reaches GA with stable keys, Topograph will evaluate aligning or providing both.

This content was originally queued for PR #264 but deferred because the target file (docs/reference/node-labels.md) didn't exist on main until #254 landed.

2. Doc-Impact Evaluation table: restore two rows (AGENTS.md + .claude/CLAUDE.md)

Adds back two rows removed from PR #269 to avoid broken cross-references to content not yet on main:

Change Docs update required
New / changed chart template (Ingress, HTTPRoute, NetworkPolicy, ServiceMonitor, etc.) docs/engines/k8s.md "Exposing the Topograph API" section
New / changed label or annotation key docs/reference/node-labels.md

Both target sections now exist on main:

Paired edit preserves the byte-identical invariant between AGENTS.md and .claude/CLAUDE.md from line 6 onward, verified with:

cmp <(tail -n +6 .claude/CLAUDE.md) <(tail -n +6 AGENTS.md)
# (empty output = match)

Commits

Two logical commits on this branch, one per change:

  1. docs(reference): add KEP-4962 upstream-alignment note to node-labels.md
  2. docs(agents): restore two Doc-Impact Evaluation table rows

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes. (Documentation-only PR; no tests applicable.)
  • The documentation is up to date with these changes. (This PR is the documentation update.)
  • All commits are signed off per DCO (git commit -s).

resker added 2 commits April 19, 2026 12:57
Adds a short subsection under `## Labels` covering KEP-4962
("Standardizing the Representation of Cluster Network Topology"),
which is pre-GA and still under upstream review at
kubernetes/enhancements#4962 (draft PR #4965). Notes that the KEP's
framing allows vendor prefixes like `network.topology.nvidia.com/*`
to coexist with the standard `topology.kubernetes.io/` keys rather
than replace them, and that Topograph will evaluate aligning or
providing both if and when the KEP reaches GA. For now, the
`network.topology.nvidia.com/*` keys remain authoritative for
Topograph-deployed clusters.

This note was deferred from PR NVIDIA#264 because the target file
(`docs/reference/node-labels.md`) did not yet exist on `main`; it
was introduced by PR NVIDIA#254, which merged 2026-04-19.

Signed-off-by: Rob Esker <resker@nvidia.com>
Adds back two rows to the Documentation Impact Evaluation table in
`AGENTS.md` and `.claude/CLAUDE.md` that were removed from PR NVIDIA#269
to avoid cross-referencing content not yet on `main`:

- Chart template row pointing at `docs/engines/k8s.md` "Exposing the
  Topograph API" section (added to main by PR NVIDIA#259)
- Label or annotation key row pointing at `docs/reference/node-labels.md`
  (added to main by PR NVIDIA#254)

Both gating PRs have now merged, so the rows can be restored without
broken cross-references. Paired edit preserves the byte-identical
invariant between `AGENTS.md` and `.claude/CLAUDE.md` from line 6
onward (verified with `cmp`).

Signed-off-by: Rob Esker <resker@nvidia.com>
@resker resker requested a review from dmitsh as a code owner April 19, 2026 17:58
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 19, 2026

Greptile Summary

This documentation-only PR adds a KEP-4962 upstream-alignment note to docs/reference/node-labels.md and restores two previously-deferred rows to the Doc-Impact Evaluation table in both AGENTS.md and .claude/CLAUDE.md. All cross-references now resolve correctly on main, and the byte-identical invariant between the two agent guidance files is preserved.

Confidence Score: 5/5

Safe to merge — documentation-only changes with no code impact.

All three files contain purely additive documentation; no logic, API contracts, or labels are modified. The AGENTS.md / CLAUDE.md sync invariant is maintained, cross-references resolve, and there are no P0/P1 findings.

No files require special attention.

Important Files Changed

Filename Overview
docs/reference/node-labels.md Adds a 'Relationship to upstream standardization (KEP-4962)' subsection between the configuring-label-keys section and the 'Without Topograph' section; content is accurate, well-hedged, and links correctly to the upstream KEP issue and PR.
AGENTS.md Restores two previously-deferred Doc-Impact Evaluation table rows (chart template → k8s.md and label/annotation key → node-labels.md); both target sections now exist on main.
.claude/CLAUDE.md Byte-identical paired edit to AGENTS.md (lines 6+), restoring the same two Doc-Impact table rows to maintain the enforced sync invariant between the two files.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["AGENTS.md\n(Doc-Impact table +2 rows)"] -- "byte-identical sync (lines 6+)" --> B[".claude/CLAUDE.md\n(Doc-Impact table +2 rows)"]
    C["docs/reference/node-labels.md\n(KEP-4962 subsection added)"]
    B -- "row: New / changed label key →" --> C
    A -- "row: New / changed label key →" --> C
    D["docs/engines/k8s.md\n('Exposing the Topograph API' section)"]
    B -- "row: New / changed chart template →" --> D
    A -- "row: New / changed chart template →" --> D
Loading

Reviews (1): Last reviewed commit: "docs(agents): restore two Doc-Impact Eva..." | Re-trigger Greptile

@dmitsh dmitsh merged commit 43ee850 into NVIDIA:main Apr 19, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants