Skip to content

installer: generate documentation for configuration #8441

Closed
@Pothulapati

Description

@Pothulapati

Is your feature request related to a problem? Please describe

Currently, Config is the spec through which users pass configuration into the installer but it isn't
documented. This means users have to check the golang types directly to understand what
all options are even allowed.

Describe the behaviour you'd like

We should be generating the documentation directly from the golang structs. Probably, Having them
as comments and rendering them out into a table in config.md should be good.

Additional context

Similar projects around this:

Metadata

Metadata

Labels

team: deliveryIssue belongs to the self-hosted team

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions