DoSomething / infrastructure

🐄 DoSomething.org's infrastructure, managed by Terraform.
MIT License
3 stars 2 forks source link

Update documentation for Terraform components. #298

Closed DFurnes closed 2 years ago

DFurnes commented 2 years ago

What's this PR do?

This pull request updates documentation for our reusable Terraform components. I've added a README with high-level description and sample usage for each module, and extracted variables and outputs into separate files (for easier scanning and the ability to link from documentation).

How should this be reviewed?

I've separated each component into it's own commit, but it may actually be easiest to browse the directory on this branch (since the diffs will appear gnarlier than they really are due to copy-pasting variables and outputs into separate files).

Any background context you want to provide?

This should make it easier for others to onboard & navigate this codebase!

Relevant tickets

References Pivotal #179704485.

Checklist