spiffe/helm-charts

Add helm-docs documentation comments to values.yaml files

オープン

#36 opened on 2023/02/22

GitHub で見るコントリビューターガイド
 (2 件のコメント) (1 件のリアクション) (0 人の担当者)Smarty (22 件のフォーク)auto 404
documentationgood first issue

Repository metrics

Stars
 (20 個のスター)
PR merge metrics
 (30d に merged 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のドキュメントを読み、コメント形式（# 説明）を理解した後、チャート内のvalues.yamlファイルにそのようなコメントを追加します。最後に./helm docs.shを実行してREADME.mdを更新します。
技術スタック
kubernetes
領域
documentationdevops
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
YAMLHelm
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90