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