docs: public-release doc cleanup + CONTRIBUTING; add Flannel sample#29
Merged
Conversation
Prepare the docs for a first public release: - Fix stale versions (v0.2.0/v0.1.0 -> v0.3.0 in pull/verify examples; Go 1.26.4+ to match go.mod) and correct the nightly-tier docs (it is wired: HA + failure-status; the kubeadm-layer upgrade is validated on the VM boundary). - Remove internal lab/VM-validation language from public docs (README, hadron, high-availability, upgrades, cni, testing) and reframe to neutral capability statements; keep the honest coverage boundary, drop the build/vmtest process. - Reframe readiness for public availability across README/docs/samples: first public release, 1.34/1.35/1.36 window, not yet certified for production (no GA/production overclaim). - Fix the front-door README grammar (N-2 bullet, CNI bullet, Hadron bullet, and the 'that plugs into' typo) and complete the docs table (Hadron, Testing). - Move the 'Verifying a release' + 'Releasing' content out of the README into a new CONTRIBUTING.md (build/test, DCO sign-off, verification, release cut); the README links to it. - Add and surface the Flannel CNI sample (samples/cni-flannel/) in the README, docs/README, and docs/cni.md alongside Calico. Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: William Rizzo <william.rizzo@gmail.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
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.
What
Prepare the public documentation for a first public release. Two independent
reviews (accuracy/values + technical-writing) were synthesized into a single pass.
Changes
v0.2.0/v0.1.0pull, verify, and releaseexamples → v0.3.0; Go 1.26.4+ (matches
go.mod);status.mdsampleversion.
testing.mdsaid the nightlytier was "planned / not yet wired" — it is wired (HA + failure-status). The
kubeadm-layer in-place upgrade is documented as validated on the VM boundary.
hadron.md,high-availability.md,upgrades.md,cni.md,testing.md) andreframed to neutral capability statements. Kept the honest coverage boundary;
dropped the
build/vmtest/ local-run-log process detail.release, 1.34 / 1.35 / 1.36 window, not yet certified for production — no
GA/production overclaim.
that plugs intotypo, and a completed Documentation table (added Hadron +Testing rows).
CONTRIBUTING.md: the "Verifying a release" and"Releasing" content moved out of the README (plus a short build/test + DCO
preamble); the README links to it.
samples/cni-flannel/is added and referencedin the README,
docs/README.md, anddocs/cni.mdalongside Calico.Validation
fmt-check/vet/buildgreen; all referenced links resolve; the Flannelsample was validated on a real 2-node libvirt cluster (both nodes Ready,
kube-flannel-ds2/2, cross-node pod ping 0% loss).Notes (out of scope here)
go.modis1.26.4while CLAUDE.md's policy says 1.26.3 — worth reconcilingseparately.