docs(rfcs): PR-G — fix stale RFC-0004 paths after archive move#182
Merged
Conversation
RFC-0013 §migration step 9 (PR-G) moved RFC-0004 to docs/rfcs/archived/ but two stale references kept the pre-move path: - components/exporters/stdoutexporter/README.md: markdown link rendered broken on GitHub. - tools/components-gen/main.go: code-comment pointer would send a contributor to a 404 when looking up the dual-export pattern source. Update both to docs/rfcs/archived/0004-clockreceiver-stdoutexporter.md. No header/index changes — every RFC already carries a status line plus a Superseded/Revised-by RFC-0013 redirect blockquote with a working link, and docs/rfcs/README.md already routes [0004] to the archived path. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Tri Lam <tri@maydow.com>
4 tasks
trilamsr
added a commit
that referenced
this pull request
May 31, 2026
## Summary Reconcile the four pivot-tracking docs (`docs/rfcs/0013-distro-first-pivot.md`, `CHANGELOG.md`, `MILESTONES.md`, `docs/migration/v0.1-to-v0.2.md`) with the wave-3 (PR-B1-shape sibling ports) and wave-4 (PR-B2-shape upstream-only ports + PR-F.1 + PR-J + PR-L + PR-N) landings. Pure doc sweep — no code or config touched. ## What changed ### `docs/rfcs/0013-distro-first-pivot.md` §migration PR sequence rows updated with PR-number citations and landed markers: - **PR-A2** (landed, #189, 2026-05-30) - **PR-B2** (landed, #201) — also enumerates sibling-receiver follow-ups under PR-B2 to dispel the slug collision with #188's PR-B2-labelled dcgm port: stdoutexporter (#202), pyspy (#203), kernelevents (#208), containerstdout (#209) - **PR-F.1** (landed) — fleshed-out delete list (`internal/{selftelemetry,telemetry}` + `components/receivers/dcgm/` + `pkg/dcgm/` + one orphan clockreceiver integration test) - **PR-F.2** re-scoped — now deletes the whole `internal/{componentstatus,pipeline,pipelinebuilder,consumer,fanout,runtime/lifecycle}` bundle in one cut once the last three pipeline+consumer-importing receivers land (#204 k8sevents, #205 clockreceiver, #207 otlphttp). Per the import-graph state — `internal/componentstatus`'s only non-test consumer is `internal/pipeline`, so they delete together - **PR-G** (landed, #182), **PR-H** (landed, #183) - **PR-I.1a** (in flight — scaffold agent), **PR-I.1b** (pre-staged; gate satisfied by #201) - **PR-J** (landed, #195) — kept existing marker - **PR-K.1** (in flight — separate agent landing) - **PR-L** (landed, skeleton #179 + body #191) — flagged as living document - **PR-N** (landed, #200) — shipped at v0.1.0 ahead of v0.3.0 as a doc-only update at `docs/migration/v0.2-to-v0.3.md` ### `CHANGELOG.md` [Unreleased] - Restructured the pivot wave list as **four waves** (was three). Wave 3 enumerates PR-B1-shape sibling ports + support infra (#180-#194/#196). Wave 4 enumerates PR-B2-shape upstream-only ports + PR-J (#195) + PR-F.1 (#206) + PR-N (#200) + lint/TOCTOU hardening (#198/#210). - Tightened the PR-F.2 deferred note to point at the three open ports (#204/#205/#207) as the gate. ### `MILESTONES.md` - **M1** (pipeline runtime) — status row now cites PR-A2 (#189), PR-F.1 (#206), PR-F.2 gate (#204/#205/#207), PR-E (#180), retains `internal/config/` (still load-bearing for `tracecore validate`). - **M2** (self-telemetry) — status row now cites PR-F.1 (#206); flags `internal/componentstatus` as travelling with `internal/pipeline` in PR-F.2. - **M8** (DCGM receiver) — status flipped to *landed-and-replaced*: cites PR-F.1 (#206) deletion + PR-J (#195) `docs/integrations/prometheus-scrape.md` recipe. Notes the inert chart toggle retention until PR-K.3. ### `docs/migration/v0.1-to-v0.2.md` - §`internal/*` package deletion (PR-F) status flips from "not yet open" to "PR-F.1 landed (#206), PR-F.2 gated on three open ports". - Open-items checklist expanded from 5 to 13 entries — tracks every PR letter the migration guide cares about (A2 / E / F.1 / F.2 / I.1a-c / J / K.1-3 / L / N) with PR numbers and links. ## Why now Tracking docs accumulated drift across wave-3 + wave-4 because every sibling-port PR (and the support-infra PRs around them) updated the bottom of `CHANGELOG.md` but did not always touch the upstream sequencing section in RFC-0013. Per memory rule `[Keeping this document current]`: status drift is a review blocker. This PR is the consolidated catch-up; future port PRs include their RFC-row flip in-PR. ## What this PR does NOT change - No code, no config, no YAML, no chart — only the four tracking docs. - No new doc gates added; existing gates pass. - No PRs other than the four named docs are modified. ## Test plan - [x] `bash scripts/doc-check.sh` clean (33 test refs, 528 links resolve, comment-noise diff gate clean vs `origin/main`, all 13 gates green). - [x] Pre-commit hook (`commitlint` 72-char subject limit + DCO + AI-trailer gates) passed. - [x] Pre-push hook (`make ci-fast` equivalent: `golangci-lint`, `go vet`, `go mod verify`, `no-autoupdate-check`, `doc-check.sh`) passed on second attempt after `git fetch origin main` populated the worktree's `origin/main` ref — first push failed because the worktree previously tracked the (gone) `pr-a2-ocb-main-swap` branch, so `doc-check.sh`'s comment-noise diff-scope gate exited 128 on the missing ref. Root cause fixed by the fetch; not a workaround. - [ ] CI green on this branch. ```release-notes NONE ``` Signed-off-by: Tri Lam <tri@maydow.com> Co-authored-by: Tri Lam <tri@maydow.com>
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PR-G sliver per RFC-0013 §migration step 9: close the residual gap left after RFC-0004 was moved to
docs/rfcs/archived/. The supersession headers, redirect blockquotes, and RFC index were all updated in earlier waves, but two non-RFC files kept the pre-move path:components/exporters/stdoutexporter/README.md— markdown link that renders broken on GitHub.tools/components-gen/main.go— code comment pointer.Both updated to
docs/rfcs/archived/0004-clockreceiver-stdoutexporter.md.Audit scope (per PR-G charter)
Verified rigorously, not just trusting prior summaries:
docs/rfcs/*.md(non-archived) RFC 0001–0012 carries aStatus:line declaringsuperseded by RFC-0013orrevised by RFC-0013, plus a> **Superseded by [RFC-0013](0013-distro-first-pivot.md)** ...redirect blockquote with a working link. Header phrasing is not byte-identical across files (e.g. 0006 omits the leading-, 0007'sStatus:is at line 9 instead of 3 due to a §Numbering note) but the status semantics and link integrity are correct. Cosmetic-only deltas skipped per the no-bloat / scope discipline.docs/rfcs/README.mdindex — correctly routes[0004]toarchived/0004-clockreceiver-stdoutexporter.md; all of 0001–0012 listed as superseded/revised by RFC-0013; 0013 listed as draft. All thirteen file links resolve.docs/rfcs/0003-...mdRFC-0004 references — three links at lines 441, 442, 498 all use the correctarchived/0004-clockreceiver-stdoutexporter.mdrelative path (sibling directory fromdocs/rfcs/).docs/rfcs/0007-...md— line 266 reference uses the correct archived path.CHANGELOG.md— RFC-0004 link at line 71 usesdocs/rfcs/archived/0004-clockreceiver-stdoutexporter.md.grep -rn 'rfcs/0004'across*.md/*.go/*.yamlsurfaced only the two files this PR fixes; everything else either usesarchived/0004...or is prose-only without a link.Test plan
grep -rn 'rfcs/0004' --include='*.md' --include='*.go'returns onlyarchived/0004...paths after this commit.Release notes