Automate terraform-docs updates #202
Description
Currently, terraform-docs throughout the repo have to be "manually" updated via CLI, typically by navigating to the directory they exist in and running a terraform-docs command.
We can make it easier for developers to update docs and ensure they stay updated:
- Add terraform-docs to pre-commit (see https://github.com/Element84/terraform-aws-stac-server/blob/main/.pre-commit-config.yaml and https://github.com/Element84/terraform-aws-stac-server/blob/main/.terraform-docs.yml for an example setup)
- In a
CONTRIBUTING.mdnote the command devs can use to update docs (e.g.pre-commit run terraform-docs-go --all-filessee https://github.com/Element84/terraform-aws-stac-server/blob/main/CONTRIBUTING.md)