Project conventions: documentation - Githubissues

ContainerSolutions / terraform-examples

Simple and idiomatic examples of various Terraform functions and features.

https://containersolutions.github.io/terraform-examples/

159 stars 51 forks source link

Project conventions: documentation #58

Open ttarczynski opened 3 years ago

ttarczynski commented 3 years ago

One of our conventions is not yet documented and not enforced with bin/check* scripts. It is:

There should be comments explaining and linking to documentation
Please compare: google/google_compute_instance/simple/main.tf

The comments that we want to have in all examples:

# Summary: – 1-line summary of what this example does
# Documentation: – add link to documentation before each block (terraform, provider, variable, resource, etc.)
# Explanation: – add only where some extra explanation is needed

TODO:

[x] add this convention to README
[ ] #183