Update helm setup docs #2040
Update helm setup docs #2040
Conversation
|
Bismuth encountered an error |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Greptile Summary
This PR transforms the Helm deployment documentation from a basic configuration reference into a comprehensive step-by-step deployment guide. The changes restructure the content to provide a better user experience by adding clear prerequisites, step-by-step guidance, and production-ready configuration examples.
Key improvements include:
- Updated Helm installation commands using the OCI registry format
- Enhanced configuration examples with explicit production vs testing guidance
- New sections covering secrets management, database configuration options, and GitHub App setup
- Improved formatting using MDX components for better readability
- Complete
values.yamlexample showcasing all configuration options
The documentation now follows a logical workflow that separates initial deployment from GitHub App configuration, which better matches the actual user experience. This change reflects the product's maturation and targets enterprise users who need detailed deployment guidance for production environments.
Confidence score: 3/5
- This PR appears safe to merge as it only updates documentation without affecting application code.
- The score reflects potential inconsistencies between documented configuration examples and actual Helm chart structure that could confuse users.
- The
docs/ce/self-host/deploy-helm.mdxfile needs verification to ensure all configuration examples match the actual Helm chartvalues.yamlstructure.
1 file reviewed, 2 comments
| httpBasicAuthUsername: "admin" | ||
| httpBasicAuthPassword: "<strong-password>" | ||
| bearerAuthToken: "<strong-token>" | ||
| hostname: "digger.example.com" | ||
|
|
||
| # GitHub App credentials (filled after setup) | ||
| githubOrg: "" | ||
| githubAppID: "" # Note: uppercase ID | ||
| githubAppClientID: "" | ||
| githubAppClientSecret: "" | ||
| githubAppKeyFile: "" # base64 encoded private key | ||
| githubWebhookSecret: "" | ||
| ``` |
There was a problem hiding this comment.
logic: The secret key names in the documentation (camelCase) don't match the actual Helm chart expectations (UPPER_CASE with underscores). For example, the chart expects 'GITHUB_APP_ID' but the docs show 'githubAppID'.
| secret: | ||
| postgresPassword: "<test-password>" |
There was a problem hiding this comment.
logic: The nested 'secret' structure under 'postgres' doesn't match the actual chart structure which expects 'postgres.secret.password' not 'postgres.secret.postgresPassword'.
No description provided.