docs: fix quickstart guide with accurate setup info#15
Merged
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the quickstart guide with specific Node.js and Go version requirements, clarifies Docker container behavior for various development modes, and adds detailed manual setup instructions including a configuration example. Review feedback highlighted an inconsistent database name in a mongosh command and a discrepancy regarding the requirement status of the ENCRYPTION_KEY variable.
mohit-nagaraj
force-pushed
the
docs/fix-quickstart-guide
branch
from
5a4dd0d to
b36636c
Compare
- Add conditional prerequisites table (Node.js 20+, Go 1.25+ per setup path) - Clarify what orchcli start -d runs in Docker vs host for each dev mode - Fix manual setup: add working config.yaml values, correct MONGO_URI for Docker-based MongoDB (no auth), add .env.local step for UI - Fix exec example: postgres -> mongodb - Expand Required Core Configuration table with optional fields - Fix Go install command to use correct module path (github.com/kubeorch/cli) Fixes #14 Signed-off-by: Mohit Nagaraj <mohitnagaraj20@gmail.com>
mohit-nagaraj
force-pushed
the
docs/fix-quickstart-guide
branch
from
b36636c to
b3f441d
Compare
- Fix database name: kubeorchestra -> kubeorch (bot feedback) - Fix ENCRYPTION_KEY requirement: No -> Yes (needed for clusters) - Convert to .mdx for component support - Add platform tabs for installation (macOS/Linux, Windows, NPM, Go) - Add winget and Scoop install methods for Windows Signed-off-by: Mohit Nagaraj <mohitnagaraj20@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.
Summary
orchcli start -druns in Docker vs on the hostconfig.yamlvalues, correctMONGO_URIfor Docker MongoDB (no auth),.env.localstep for UIorchcli execexample:postgres->mongodbgithub.com/kubeorch/cli(was wrong module path)Test plan
Fixes #14
Related CLI fix: KubeOrch/cli#46