New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Suggestion] Require documentation of the terraform modules included in each corral package template #7

Open

git-ival opened this issue Mar 2, 2023 · 0 comments

Contributor

git-ival commented Mar 2, 2023

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment