helm-chart icon indicating copy to clipboard operation
helm-chart copied to clipboard

Update README.md

Open TomAugspurger opened this issue 4 years ago • 2 comments

I believe these docs were out of date.

TomAugspurger avatar Aug 20 '20 15:08 TomAugspurger

Thanks @TomAugspurger.

We use Frigate here for autogenerating the README. The main benefit is that it keeps the table of configuration options up to date. Would you mind updating the template and regenerating the REAMDE?

https://github.com/dask/helm-chart#generating-the-readme

(I made some changes to Frigate this week which will make it super useful for daskhub as it will pull all the possible configuration options from the dependency charts too)

jacobtomlinson avatar Aug 20 '20 16:08 jacobtomlinson

This whole process of using a template and generating the README from it is a little annoying. Frigate also has a sphinx plugin so we may just want to move the docs to RTD instead of the README to make the whole experience more pleasant.

jacobtomlinson avatar Aug 20 '20 16:08 jacobtomlinson