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.

Sign up for GitHub

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

Jump to bottom

Alignment on Helm README Documentation #406

Open
3 tasks
sabre1041 opened this issue Nov 8, 2022 · 2 comments
Open
3 tasks

Alignment on Helm README Documentation #406

sabre1041 opened this issue Nov 8, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@sabre1041
Copy link
Collaborator

Goal

Strategy for defining the content provided in the README of each Helm Chart and aligning each of the Charts within the repository

Overview

Currently, the Helm charts that are contained within this repository make use of a varying method of managing the README.md files. Most charts are making use of the helm-docs tool to generate content. Some are also making use of template files that are interpreted by the helm-docs tool to render the content of the README.md file

Approach

Determine the best approach for managing README.md files

  • Determine tool (if any) to assist with the generation of README.md files
  • Determine the content that should be part of each Helm chart
  • Update documentation that details the processes that should be followed

cc: @cpanato @hectorj2f
@sabre1041 sabre1041 added the enhancement New feature or request label Nov 8, 2022
@tahirraza
Copy link
Contributor

Agreed.

@hectorj2f
Copy link
Contributor

It sounds good to me. 👏🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@sabre1041 @tahirraza @hectorj2f