docs(readme): lead Quick Start with the Helm deploy, not the Tilt stack#522
Merged
Conversation
The README Quick Start walked through the Tilt local-dev stack (mkcert, make dev, terrapod.local) and buried the actual install in a later "Production Deployment" section. That gives the wrong first impression of what Terrapod is and how you run it. Make Quick Start the Helm deploy onto a Kubernetes cluster (or a single-node k3s VM), fold the former Production Deployment block into it, and point contributors who want to run from source at docs/local-development.md. Update the docs table accordingly.
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.
Follow-up to #521. The repo README — the most visible front door — still led its Quick Start with the Tilt local-dev walkthrough (
mkcert,make dev,terrapod.local) and buried the real install in a later "Production Deployment" section.This makes Quick Start the Helm deploy onto a Kubernetes cluster (or a single-node k3s VM), folds the former Production Deployment block into it, switches example hostnames to
terrapod.example.com, and points contributors at the newdocs/local-development.mdfor the from-source/Tilt workflow. Docs table updated to match.Docs-only; no code or chart changes. Diff scanned for internal identifiers — clean.