Rewrite README with accurate end-to-end setup guide - #39
Merged
Conversation
The previous README was significantly incomplete and contained inaccuracies that would block a new user from getting started. - Rewrote overview to capture the purpose of DevEnv (personal, persistent, SSH-accessible Linux environments in Kubernetes) - Fixed build instructions: make → task - Documented required directory structure and config file layout - Added annotated YAML examples for both config files - Added step-by-step workflow from directory setup through kubectl apply - Added CLI reference with all flags (including --no-cleanup which will be added in an upcoming PR) - Added Field Glossary split by config file, with required/optional column, defaults, and additive merge behavior noted per field
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
2 participants
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.
The previous README was significantly incomplete and contained inaccuracies that would block a new user from getting started.
Closes PLT-858