helm icon indicating copy to clipboard operation
helm copied to clipboard

chore(nextcloud): switch to helm-docs

Open wrenix opened this issue 1 year ago • 0 comments

Description of the change

use helm-docs for documentation

Benefits

No duplicated documentation between README and values.yaml

Possible drawbacks

Not yet so good structed as before, TODOs are:

  • [x] give every value in values.yaml a usefull documentation (split to #693 )
  • [x] group to sections
  • [ ] add extra documentations on the README helm-docs template
  • [ ] add ci-job to check if README is uptodate

Applicable issues

fixes #547

Additional information

Readme rendered

Checklist

wrenix avatar Sep 21 '24 10:09 wrenix