scaffold: link the README dev section to dev/README.md and add a pre-alpha banner - #25
Merged
Merged
Conversation
The root README duplicated the dev-environment setup that dev/README.md already owns: prerequisites, the .env copy, and the raw tilt invocation. The two were free to drift. The root README now states the requirement (a Kubernetes cluster), lists the make targets a contributor runs, and links to dev/README.md for the rest. dev/README.md gains the existing-cluster workflow and documents K8S_CONTEXT and DOCKER_REGISTRY_URL alongside the other .env settings. Signed-off-by: Diogo Recharte <diogo.recharte@solanica.io>
Nothing in the README told a reader that v2 and the providers are still moving under them. The compatibility table implies stability, and several providers have no release at all, so the only signal was what was missing. Adds a WARNING callout above the badges stating the consequence rather than the sentiment (schemas and chart values change in breaking ways, no upgrade path, not for production), plus a status badge so it stays visible when the callout scrolls off. Both carry a TODO(sdk) marker so the sweep at v2 GA is one grep for "status-pre--alpha". Signed-off-by: Diogo Recharte <diogo.recharte@solanica.io>
recharte
marked this pull request as ready for review
August 6, 2026 08:52
Review feedback on the provider READMEs: "Version upgrades" read as though it might be about upgrading the provider, and the reader only worked out it meant the deployed version after reaching the Notes column. The ambiguity applies to the whole table, so it is fixed once above it rather than by renaming a row: the row names stay identical across providers, which is what makes the tables comparable. Signed-off-by: Diogo Recharte <diogo.recharte@solanica.io>
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
Two follow-ups to #24 that landed on the branch after it was merged, so they never reached
main. They are already applied to all eight provider repositories, so the template needs them to stay the source of truth.Tracked by the fleet PRs: openeverest/provider-percona-server-mongodb#76, openeverest/provider-percona-xtradb-cluster#15, openeverest/provider-percona-postgresql#15, openeverest/provider-altinity-clickhouse#27, openeverest/provider-kubeai#13, openeverest/provider-valkey#5, openeverest/provider-kserve#25, openeverest/provider-mariadb#29.
Development section points at
dev/README.mdThe template's root README duplicated the dev-environment setup that
dev/README.mdalready owns — prerequisites, the.envcopy, and the rawtilt upinvocation — so the two were free to drift.The root README now states the requirement (a Kubernetes cluster, not k3d specifically), lists the make targets a contributor runs, and links to
dev/README.mdfor the rest.dev/README.mdabsorbs what was removed plus what it was missing: a Using a cluster you already have section, andK8S_CONTEXT/DOCKER_REGISTRY_URLdocumented alongside the other.envsettings. Both were already in.env.examplebut undocumented, which is how the root README ended up being the only place describing the remote-cluster workflow.Pre-alpha status banner
Nothing in the README told a reader that v2 and the providers are still moving under them. The compatibility table implies stability, and several providers have no release at all, so the only signal was what was missing.
Adds a
> [!WARNING]callout above the badges stating the consequence rather than the sentiment — schemas and chart values change in breaking ways, no upgrade path, not for production — plus a status badge so it stays visible once the callout scrolls off. It sits above the badges and separately from the existing> [!IMPORTANT]"not standalone" callout inside What this is, so the two never stack.Both carry a
TODO(sdk)marker, so the sweep at v2 GA is one grep forstatus-pre--alpha.Still open, and deliberately out of scope here: whether the banner should also go on
openeverestcore,helm-chartsand this repository's own README — providers carrying one while core does not reads as though only the providers are unstable.go test ./internal/scaffold/passes.