avirajkhare00 opened a new issue, #2985: URL: https://github.com/apache/iggy/issues/2985
Context > Also, should we clean up comments from values.yaml, otherwise there will always be documentation drift between two Good point. For this PR, the `values.yaml` comment and `README` are consistent (both describe `serviceMonitor` as opt-in for Prometheus Operator users), so there's no immediate drift. But you're right that maintaining descriptions in both places long-term is fragile. The # -- comments in values.yaml follow the [helm-docs](https://github.com/norwoodj/helm-docs) convention -- the standard approach is to auto-generate the `README` parameter table from those comments so there's a single source of truth. That would be a nice follow-up but shouldn't block this PR. @avirajkhare00 _Originally posted by @atharvalade in https://github.com/apache/iggy/issues/2976#issuecomment-4094371057_ Tool to use: https://github.com/norwoodj/helm-docs Open to feedback for the same. -- 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]
