UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects

docs: add autodocs generation for helm values

Merged joshwolf requested to merge 141-add-documentation-for-bigbang-helm-values into release-1.1
All threads resolved!

Summary

Restructure comments section in chart/values.yaml to support helm autodocs, include a README.md.gotpl to re-create README.md using:

docker run -v "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:v1.5.0 --dry-run -s file -t .gitlab-ci/README.md.gotmpl

Eventually add this to some pre-commit hook.

Edited by joshwolf

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • joshwolf resolved all threads

    resolved all threads

  • joshwolf added 1 commit

    added 1 commit

    • 3735ce14 - docs: update README with auto generated docs for values

    Compare with previous version

  • kevin.wilder approved this merge request

    approved this merge request

  • merged

  • Please register or sign in to reply
    Loading