docs: reconcile 3 stale doc references post-v0.2.0 (closes #256 #257 #259)#263
Merged
Conversation
added 3 commits
May 31, 2026 20:26
Banner predates the PR-M deferral memo in #222 — pyspy ships as-is in v0.3.0 with unchanged zero-capability posture until OTel Profiles reaches Beta + parca-agent gains OTLP export. Reframe README + RUNBOOK status banners to name #222 as the source of truth for re-evaluation triggers; keep the CAP migration pointer to docs/migration/v0.2-to-v0.3.md as forward-looking material.
Add deferral banners at §4 Migration timeline (v0.3.0 row) and §Migration/rollout v0.3.0 sequencing. Annotate the §7 Deletion list rows (pyspy receiver + python/tracecore_pyspy + tools/pyspy-lint) and the PR-M sequencing entry with explicit '(deferred to v0.4.0+ per #222)' markers. Re-evaluation triggers (OTel Profiles → Beta + parca-agent OTLP export OR sibling-distro re-scope) named at the point of the stale claim, not just in cross-references. Historical sequencing preserved verbatim. Signed-off-by: Tri Lam <tri@maydow.com>
PR #258 drops .goreleaser.yaml in favor of an inline-shell package job in .github/workflows/release.yml. Update docs/reproducibility.md + docs/notes/reproducibility.md to match: - Drop all .goreleaser.yml / .goreleaser.yaml references (file deleted; the .yml extension was always typo'd — never existed). - Drop signer-workflow references to the never-existed .github/workflows/goreleaser.yml; the actual file is .github/workflows/release.yml. - Reframe the build narrative around the new deterministic-byte controls: SOURCE_DATE_EPOCH (tag commit timestamp) + tar --mtime + --sort=name + --owner=0 --group=0 --numeric-owner + gzip -n. - Update download patterns + verification commands to operate on tar.gz archives (binary + LICENSE + README.md inside) rather than the prior bare binary. - Per-archive CycloneDX SBOMs now follow tracecore_*_linux_amd64.tar.gz.sbom.cdx.json filename pairing; the canonical source-tree SBOM still comes from the sbom job. - Add an explicit sha256sum -c checksums.txt step after download so the operator-facing integrity chain (sha256sum → checksums.txt → cosign bundle) is named in the walkthrough. - Cosign bundle naming (tracecore_*.cosign.bundle, checksums.txt.cosign.bundle) is unchanged. Signed-off-by: Tri Lam <tri@maydow.com>
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
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
Three concern-isolated doc-rot reconciles, one commit per issue:
components/receivers/pyspy/README.md+RUNBOOK.mdreframe the stale 2026-05-22 "Scheduled for deletion at v0.3.0" banner to "deferred to v0.4.0+ per #222" with the OTel-Profiles-→-Beta + parca-agent-OTLP-export re-evaluation triggers named verbatim.docs/rfcs/0013-distro-first-pivot.mdadds deferral banners at §4 Migration timeline (v0.3.0 row) and §Migration/rollout v0.3.0 sequencing; annotates the §7 Deletion list rows + PR-M sequencing entry with explicit(deferred to v0.4.0+ per #222)markers. Historical sequencing preserved verbatim (option 1 from the issue).docs/reproducibility.md+docs/notes/reproducibility.mdreconciled against post-PR-fix(release): replace goreleaser pro-only prebuilt builder with OSS-compatible shape #258 inline-shellpackagejob: drop all.goreleaser.yaml/.goreleaser.yml/goreleaser.ymlsigner-workflow references; reframe build narrative aroundSOURCE_DATE_EPOCH+tar --mtime+--sort=name+gzip -ndeterministic-byte controls; update download patterns + verification commands to operate on tar.gz archives; add an explicitsha256sum -c checksums.txtstep so the operator integrity chain (sha256sum → checksums.txt → cosign bundle) is named in the walkthrough. Cosign bundle naming unchanged.Root causes
docs/migration/v0.2-to-v0.3.mdbut explicitly left the receiver READMEs out of scope..goreleaser.yaml; the reproducibility docs additionally referenced a never-existed.github/workflows/goreleaser.ymlsigner-workflow path (the file has always beenrelease.yml), so the docs were doubly-broken pre-fix(release): replace goreleaser pro-only prebuilt builder with OSS-compatible shape #258 and singly-broken post-fix(release): replace goreleaser pro-only prebuilt builder with OSS-compatible shape #258.Sequencing note
PR #258 is the source of truth for the post-pivot inline-shell
packagejob referenced by the #259 reconcile. #258 is currently open + green; if #258 merges first, the doc paths are immediately accurate. If this PR merges first, the docs describe the target state and converge once #258 lands. Either order works.Test plan
bash scripts/doc-check.sh— clean (500 markdown links resolve, 47 non-.md intra-repo links resolve, banned-phrase lint clean, all required sections present, 10 fenced bash/sh blocks indocs/reproducibility.mdshell-syntax-clean).make check— clean (gofumpt, tidy-check, golangci-lint 0 issues, go vet, go mod verify).#222issue links +docs/migration/v0.2-to-v0.3.mdcross-references resolve; confirmed RFC(deferred to v0.4.0+ per #222)markers attached at every flagged line (matrix row, deletion-list rows, §Migration/rollout sequencing entry); confirmed reproducibility docs no longer mentiongoreleaseranywhere viagrep -i goreleaser..github/workflows/release.yml+ deletes.goreleaser.yaml, no overlap with this PR's files).Out of scope / follow-ups
No new doc-rot noticed beyond the three issues addressed here.
Closes #256.
Closes #257.
Closes #259.