-
Notifications
You must be signed in to change notification settings - Fork 72
doc: Improve generic helm chart installation docs #1458
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
doc/content/enterprise/kubernetes/generic/prerequisites/sample-ingress-controllers.md
Outdated
Show resolved
Hide resolved
doc/content/enterprise/kubernetes/generic/prerequisites/sample-ingress-controllers.md
Outdated
Show resolved
Hide resolved
KrishnaIyer
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great!
doc/content/enterprise/kubernetes/generic/configuration/_index.md
Outdated
Show resolved
Hide resolved
doc/content/enterprise/kubernetes/generic/prerequisites/_index.md
Outdated
Show resolved
Hide resolved
424c721 to
427299e
Compare
|
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
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.