Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Helm: Generate a README.md file containing the values parameters #1173

Closed
Sgitario opened this issue Mar 27, 2023 · 1 comment · Fixed by #1176
Closed

Helm: Generate a README.md file containing the values parameters #1173

Sgitario opened this issue Mar 27, 2023 · 1 comment · Fixed by #1176
Assignees

Comments

@Sgitario
Copy link
Collaborator

Suggestion

Generate for each chart a README.md file including the table of the parameters: Name | Description | Default)

Example: https://github.com/jenkinsci/helm-charts/blob/main/charts/jenkins/VALUES_SUMMARY.md#jenkins

# Jenkins

## Configuration

The following tables list the configurable parameters of the Jenkins chart and their default values.

### Jenkins Controller

| Parameter                                   | Description                                                              | Default                                                              |
|---------------------------------------------|--------------------------------------------------------------------------|----------------------------------------------------------------------|
| `checkDeprecation`                          | Checks for deprecated values used                                        | `true`                                                               |
| `clusterZone`                               | Override the cluster name for FQDN resolving                             | `cluster.local`                                                      |
| `nameOverride`                              | Override the resource name prefix                                        | `jenkins`                                                            |

That will improve the readability of the chart generated when it will be published on a Helm repo like also its team's adoption by a project

2 tools currently exist to generate such tables but up to you to decide if you prefer to generate it part of this extension:

@Sgitario
Copy link
Collaborator Author

#1174 is a prerequisite for this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant