NeoShowcase
NeoShowcase copied to clipboard
helmチャートのドキュメントを追加
なぜやるか
values.yamlを直接見るより、mdを見たほうがわかりやすいから。
やったこと
values.yamlのコメントを調整し、helm-docsを用いてドキュメントを生成した。
やらなかったこと
もし実用するなら、CIやPre-commit hookを用いてドキュメントを最新の状態に保つ必要がある。
資料
Preview (prod backend + PR dashboard) → https://1100.ns-preview.trapti.tech/
現状だとコメントが少なくてドキュメントが見にくいかもですね、見通しはよくなったかな