全てのモジュールにREADME.mdを配置する

ルール

Always place README.md in every module. README.md should have module information auto-inserted by terraform-docs

(全てのモジュールにREADME.mdを配置する)

解説

README.mdには本来目的や概要を記すのですが、それらをSpec-Drivenではspec.mdに記します。 そのためterraform-docsによって自動生成されたドキュメントがREADME.mdのメインコンテンツとなります。

サンプルコード

# Networking Module

<!-- BEGIN_TF_DOCS -->
<!-- END_TF_DOCS -->

参考リンク

Show Text to Share
全てのモジュールにREADME.mdを配置する
https://www.tricrow.com/infrastructure/development-guidline/repository_structure.standard.readme.html
この記事を書いた人
T.Nakamura
T.Nakamura
SRE | セキュリティ前提の設計・運用・監査対応(PCI DSS) | ドキュメント整備と仕組み化で開発・運用を整えます | AWS SAP / 日商簿記一級フォローはこちら

カテゴリ

タグ