[Suggestion] Require documentation of the terraform modules included in each corral package template #7
Description
Ideally each corral package template would include a README.md with some information on what it does/provides + documentation on all the terraform.
Some easy options include:
- Using terraform-docs to auto-generate the README content (minus any specific description of how the corral works)
- (More involved) Include pre-commit + pre-commit-terraform configuration files that will:
- Auto-format the terraform
- Auto-generate the terraform READMEs
- Here is a link to how this can be setup (we use this in the rancher2-scaling repo, version #s should be changed to latest).