-
Notifications
You must be signed in to change notification settings - Fork 60
Open
Labels
area/documentationDocumentation relatedDocumentation relatedarea/usabilityUsability relatedUsability relatedkind/enhancementEnhancement, improvement, extensionEnhancement, improvement, extension
Description
How to categorize this issue?
/area documentation
/area usability
/kind enhancement
What would you like to be added:
The Helm chart documentation is lacking, forcing users to reverse-engineer values and code. We need:
-
Comprehensive documentation for the chart's
values.yamlfile, including:- Detailed descriptions of all configuration options
- Example usage for operator personas
- Best practices and common patterns
-
A published Helm repository index (e.g., GitHub Pages) with:
- Browsable installation instructions
- Chart versioning information
- Easy discovery and consumption
Why is this needed:
Currently, users must read through the source code to understand how to configure the Helm chart properly. This creates a significant barrier to adoption and makes it difficult to:
- Understand available configuration options
- Deploy the operator correctly on the first try
- Integrate with GitOps workflows that rely on Helm repositories
- Onboard new users and teams
Publishing proper documentation and a Helm repository would significantly improve the user experience and make the project more accessible to the broader Kubernetes community.
Metadata
Metadata
Assignees
Labels
area/documentationDocumentation relatedDocumentation relatedarea/usabilityUsability relatedUsability relatedkind/enhancementEnhancement, improvement, extensionEnhancement, improvement, extension