Skip to content

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

Closed

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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