Skip to content

Conversation

@vlasebian
Copy link
Contributor

Summary

Improve generic helm chart installation docs for 0.0.13 helm chart release.

Screenshots

Screenshot 2025-09-09 at 14 56 52 Screenshot 2025-09-09 at 14 58 08 Screenshot 2025-09-09 at 14 57 35 Screenshot 2025-09-09 at 14 57 22 Screenshot 2025-09-09 at 14 57 05 Screenshot 2025-09-09 at 14 57 13

Changes

  • Update Traefik ingress controller configuration example
  • Update Nginx-Ingress controller configuration example
  • Update generic ingress controller guide and map to TTS protocols
  • Reword prerequisites to clarify constraints
  • Fix random inconsistencies

Notes for Reviewers

...

Checklist

  • Scope: The referenced issue is addressed, there are no unrelated changes.
  • Run Locally: Verified that the docs build using make server, posted screenshots, verified external links. Test with HUGO_PARAMS_SEARCH_ENABLED=true if style changes will affect the search bar.
  • New Features Marked: Documentation for new features is marked using the new-in-version shortcode, according to the guidelines in CONTRIBUTING.
  • Style Guidelines: Documentation obeys style guidelines in CONTRIBUTING.
  • Commits: Commit messages follow guidelines in CONTRIBUTING, there are no fixup commits left.

@vlasebian vlasebian requested a review from Copilot September 9, 2025 12:03
Copy link
Contributor

Copilot AI left a 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.

Copy link
Contributor

@KrishnaIyer KrishnaIyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

@vlasebian vlasebian force-pushed the feat/improve-helm-installation-docs branch from 424c721 to 427299e Compare September 11, 2025 10:45
@vlasebian
Copy link
Contributor Author

I'll keep this open until I release the 0.0.13 version of the Helm chart, then I will merge it.

@vlasebian vlasebian force-pushed the feat/improve-helm-installation-docs branch from 13cda0e to c5b7016 Compare September 17, 2025 09:10
@vlasebian vlasebian merged commit edfda0e into master Sep 17, 2025
1 check passed
@vlasebian vlasebian deleted the feat/improve-helm-installation-docs branch September 17, 2025 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants