Skip to content

Use helm-docs to generate Helm README.md #3226

@deansheather

Description

@deansheather

For v1 we have a table in the README that explains the values, their descriptions and what their defaults are. We should have a similar README for helm in v2 so people know what values are available.

As part of adding the Helm chart I have already added helm-docs-compatible comments above each value so all that is left is writing the README template and adding CI to ensure it's generated properly.

Success criteria:

Metadata

Metadata

Assignees

Labels

apiArea: HTTP APIdocsArea: coder.com/docs

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    pFad - Phonifier reborn

    Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

    Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


    Alternative Proxies:

    Alternative Proxy

    pFad Proxy

    pFad v3 Proxy

    pFad v4 Proxy