spiffe/helm-charts

Add helm-docs documentation comments to values.yaml files

开放

#36 创建于 2023年2月22日

在 GitHub 查看贡献者指南
 (2 条评论) (1 个反应) (0 位负责人)Smarty (22 个派生)auto 404
documentationgood first issue

仓库指标

星标
 (20 个星标)
PR 合并指标
 (30 天内没有已合并 PR)

描述

To improve documentation of the values, we should include some comments in the style # -- description of value to document the different values in the charts.

See https://github.com/norwoodj/helm-docs for more details on usage.

Run ./helm-docs.sh to update the README.md with enhanced documentation.

贡献者指南

研究方向
阅读 helm docs 文档以了解注释格式（# 描述），然后向 charts 中的 values.yaml 文件添加此类注释。最后运行 ./helm docs.sh 更新 README.md。
技术栈
kubernetes
领域
documentationdevops
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
YAMLHelm
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90