UNCLASSIFIED - NO CUI

Create README helm-docs gotmpl to be used by all Packages

Following https://github.com/norwoodj/helm-docs/blob/master/README.md and the existing template in BigBang to create a template for a BigBang package README. This will eventually be used by all Packages within BigBang.

template should be located within the docs/ folder of gluon.

This README at a minimum should contain:

  • Badge with Current Pipeline status
  • Badge with License information (all packages should have Apachev2 license)
  • Chart version
  • CODEOWNERS
  • Link to upstream chart where applicable (Chart.yaml home should have this)
  • Links to other documents within docs/ folder (eg: overview, KEYCLOAK, etc)
  • Example Helm installation command (git clone, cd, helm command ((may not be templatable enough but would be nice to have)) )
  • Chart's values (as a table with descriptions)
Edited by Ryan Garcia