doc: Improve generic helm chart installation docs#1458
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation for the generic Helm chart installation, specifically targeting the 0.0.13 helm chart release. The updates enhance clarity around ingress controller configuration and prerequisites.
- Updates Traefik and Nginx-Ingress controller configuration examples with more comprehensive setup instructions
- Clarifies prerequisites and infrastructure requirements including database versions and port protocols
- Adds helm test verification step and fixes various documentation inconsistencies
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| sample-ingress-controllers.md | Major rewrite with expanded Traefik configuration examples and updated Ingress-Nginx controller documentation |
| _index.md (prerequisites) | Enhanced prerequisites section with clearer database version requirements and improved ingress controller guidance |
| _index.md (install-charts) | Added helm test verification step and renumbered existing steps |
| _index.md (database-migrations) | Added AS storage migration configuration and removed outdated note |
| _index.md (configuration) | Fixed typo in kubectl apply command and added TTGC network registration note |
| _index.md (generic) | Added warning formatting and minor text improvements |
| _index.md (azure/architecture) | Clarified Redis database choice rationale with additional context |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
KrishnaIyer
approved these changes
Sep 11, 2025
424c721 to
427299e
Compare
Contributor
Author
|
I'll keep this open until I release the 0.0.13 version of the Helm chart, then I will merge it. |
13cda0e to
c5b7016
Compare
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
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
Improve generic helm chart installation docs for 0.0.13 helm chart release.
Screenshots
Changes
Notes for Reviewers
...
Checklist
make server, posted screenshots, verified external links. Test withHUGO_PARAMS_SEARCH_ENABLED=trueif style changes will affect the search bar.new-in-versionshortcode, according to the guidelines in CONTRIBUTING.