docs: fix quickstart guide with accurate setup info#15
docs: fix quickstart guide with accurate setup info#15mohit-nagaraj wants to merge 1 commit intomainfrom
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.
| # Execute a command inside a container | ||
| orchcli exec core sh | ||
| orchcli exec ui sh | ||
| orchcli exec mongodb mongosh kubeorchestra |
There was a problem hiding this comment.
The database name kubeorchestra used in this command is inconsistent with the rest of the documentation, which uses kubeorch (see lines 206, 220, and 258). Using the wrong database name in mongosh will result in an empty session, preventing users from seeing the data created by the application.
| orchcli exec mongodb mongosh kubeorchestra | |
| orchcli exec mongodb mongosh kubeorch |
| |----------|----------|-------------| | ||
| | `MONGO_URI` | Yes | MongoDB connection string (e.g., `mongodb://localhost:27017/kubeorch`) | | ||
| | `JWT_SECRET` | Yes | Secret key for signing JWT tokens | | ||
| | `ENCRYPTION_KEY` | No | Key for encrypting cluster credentials at rest | |
There was a problem hiding this comment.
There is a discrepancy between this table and the configuration example provided on line 222. The ENCRYPTION_KEY is marked as not required ('No') here, but it is included in the 'minimal values for local development' section. Since the quickstart guide includes a step to 'Add a Cluster' (line 70), which typically requires this key to encrypt credentials, it should be marked as 'Yes' to ensure a smooth setup experience.
- 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
mohit-nagaraj
force-pushed
the
docs/fix-quickstart-guide
branch
from
5a4dd0d to
b36636c
Compare
1 participant
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