ChenYi015 commented on PR #2509: URL: https://github.com/apache/celeborn/pull/2509#issuecomment-2109654363
> @ChenYi015 The key point is I think the template README introduces complexity(setup and learn helm-docs) but does not gain many benefits. @pan3793 One thing I want to do is adding version control to the Helm charts, just like you see in many other Helm repos. This way, whenever we update a chart, the users can benefit from reading the latest docs. For the complexity of `helm-docs` command, please don't worry, only a `docker run` command is needed, and you do not need to learn how to install and setup helm-docs. I will update the helm developer guide later. Besides, developers do not need to learn go templates either, just update the `README.md.gotmpl` like standard markdown files, content that needs to be generated automatically is already setup. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
