Re: [PR] [CELEBORN-1415][FOLLOWUP][HELM] Refactor chart templates and update readme docs [celeborn]

["pan3793 (via GitHub)" <gi...@apache.org>]

pan3793 commented on PR #2509:
URL: https://github.com/apache/celeborn/pull/2509#issuecomment-2109519373

   Please use a new JIRA ticket, LGTM except for the following items:
   
   > - Add README template file `README.md.gotmpl`, and use [helm-docs](https://github.com/norwoodj/helm-docs)  to generate `README.md` file automatically.
   > - Add a pre-commit git hook to run to generate the latest helm chart README.md file automatically.
   
   Celeborn does use a templating approach to render the configurations page, but I would say `value.yaml` is a different case, unlike we define configurations in the Scala code, YAML itself is a format optimized for user reading, and end users are likely to read and modify the `values.yaml`. I tend to embed docs and examples into `value.yaml` as-is.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@celeborn.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org