sigstore/helm-charts

Alignment on Helm README Documentation

sabre1041 opened this issue · 2 comments

sabre1041 commented

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

tahirraza commented

Agreed.

hectorj2f commented

It sounds good to me. 👏🏻