NeoShowcase icon indicating copy to clipboard operation
NeoShowcase copied to clipboard

helmチャートのドキュメントを追加

Open Kentaro1043 opened this issue 6 months ago • 2 comments

なぜやるか

values.yamlを直接見るより、mdを見たほうがわかりやすいから。

やったこと

values.yamlのコメントを調整し、helm-docsを用いてドキュメントを生成した。

やらなかったこと

もし実用するなら、CIやPre-commit hookを用いてドキュメントを最新の状態に保つ必要がある。

資料

norwoodj/helm-docs

Kentaro1043 avatar Aug 22 '25 08:08 Kentaro1043

Preview (prod backend + PR dashboard) → https://1100.ns-preview.trapti.tech/

github-actions[bot] avatar Aug 22 '25 08:08 github-actions[bot]

現状だとコメントが少なくてドキュメントが見にくいかもですね、見通しはよくなったかな

Kentaro1043 avatar Aug 22 '25 08:08 Kentaro1043