📝 docs: remove v1alpha1 samples/refs, record supersession (8e-9) - #177
Merged
Conversation
Rewrite served-API / manifest-surface references from v1alpha1 to the single-version v1beta1 reality (v1alpha1 removed in v0.15.0, ADR-0029): - API_STABILITY: served/stored/webhooks now v1beta1-only; add historical 'v1alpha1 removed (v0.15.0)' subsection; guarantees sections retitled. - ARCHITECTURE / INSTALL_AND_USE: bump apiVersion examples and sample link text to v1beta1; drop 'v1alpha1 scope' framing. - examples/channel-authentication: fix broken 'kubectl apply' pointing at the deleted v1alpha1 sample; correct stale link labels. - index/FAQ/GLOSSARY/README/IBM_MQ_OBJECTS/NFR/ATTRIBUTE_RECONCILIATION/ GO_MODULE/RELEASE/REFERENCES.example: correct 'current API = v1alpha1' factual drift to v1beta1. - AGENTS: correct 'two API versions served' to single-version v1beta1; drop conversion-webhook narrative; repoint illustrative snippet + webhook suite path to v1beta1 (Go-package-path/fuzz refs left to lane 8e-8b). Go source structure (api/v1alpha1/ package paths, blob links, conversion fuzz) is owned by parallel lane 8e-8b and left untouched.
…sion runbook (8e-9) - Add 0.14.x -> 0.15.0 version-to-version row (breaking removal). - Version-stamp the 'Removing v1alpha1' section to v0.15.0; cite ADR-0029. - Add the one-time 'rewrite apiVersion .../v1alpha1 -> .../v1beta1 (spec identical)' step. - Reframe the stored-object rewrite + storedVersions-prune runbook as the historical, one-time precondition for v0.15.0 (clusters that ran <= v0.12). - PRESERVE the full rewrite/prune procedure and the 'do not prune before rewrite completes' warning -- this is the mitigation for the upgrade-brick risk. Fix stale forward-looking phrasings that implied v1alpha1 is still served/valid.
…alpha1 removal (8e-9) Augment the existing [Unreleased] 'Removed' entry: cite ADR-0029, deep-link the UPGRADE removal runbook anchor, and note the identical-spec apiVersion rewrite. No duplication of the 8e-8a entry.
… (8e-9) Single-version v1beta1 has no conversion to fuzz; the api/v1alpha1/ conversion_fuzz_test.go tier goes away with v1alpha1 (deleted by lane 8e-8b). Removing the bullet now prevents an orphaned stale test-tier reference in AGENTS.md. Brief branch-local mismatch until 8e-8b lands is expected (the epic lands together); AGENTS.md is not markdownlint/mkdocs gated.
konih
marked this pull request as ready for review
July 30, 2026 20:04
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Lane 8e-9 — remove v1alpha1 samples/docs, record supersession
Docs + samples only. No Go code (owned by parallel lane 8e-8b). The removal ships in v0.15.0 (ADR-0029).
What changed
API_STABILITY,ARCHITECTURE,INSTALL_AND_USE,index,FAQ,GLOSSARY,README,IBM_MQ_OBJECTS,NON_FUNCTIONAL_REQUIREMENTS,ATTRIBUTE_RECONCILIATION,GO_MODULE,RELEASE,REFERENCES.md.example, and the twoexamples/walkthroughs.examples/channel-authentication.mdhad a livekubectl apply -f …messaging_v1alpha1_channelauthrule.yamlpointing at a deleted file — repointed to v1beta1.storedVersions-prune runbook (the upgrade-brick mitigation) and its "do not prune before rewrite completes" warning; reframed it as the historical one-time precondition for v0.15.0; version-stamped the "Removing v1alpha1" section, added the "rewriteapiVersion …/v1alpha1 → …/v1beta1(spec identical)" step, and added a 0.14.x→0.15.0 version row.Out of scope (intentionally left)
Go source structure —
api/v1alpha1/package paths, GitHub blob links to*_types.go, and the conversion-fuzz bullet (AGENTS.md + CICD/DEVELOPER_GUIDE/OPERATOR_RUNTIME/ROADMAP) — is owned by parallel lane 8e-8b, which deletes those files. ADRs are historical records and untouched (0026/0027 already carry supersession notes; 0029 is the record).Gates
task lint:markdown— 0 errors (89 files)mkdocs build --strict— exit 0, no broken anchors from these editstask scrub:tree— clean (579 files)task changelog— parsesDraft — do not self-merge; awaiting independent review.