Skip to content

Publish and Improve Helm Chart Documentation for Operator Usability #1186

@mjudeikis

Description

@mjudeikis

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:

  1. Comprehensive documentation for the chart's values.yaml file, including:

    • Detailed descriptions of all configuration options
    • Example usage for operator personas
    • Best practices and common patterns
  2. 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

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions