Improve Terraform Registry documentation - Githubissues

hashicorp / terraform-aws-consul-ecs

Consul Service Mesh on AWS ECS (Elastic Container Service)

https://www.consul.io/docs/ecs

Mozilla Public License 2.0

52 stars 30 forks source link

Improve Terraform Registry documentation #90

Closed pglass closed 2 years ago

pglass commented 2 years ago

Changes proposed in this PR:

Remove markdown that doesn't render for modules in the Terraform registry.
Avoid default = null for optional variables.

How I've tested this PR:

Preview with a personal test module.
- I copied the variables.tf files to a test repo in order to preview the docs in the TF registry.
Acceptance tests

How I expect reviewers to test this PR:

Double check logic changes for non-null default values

Checklist:

[x] Tests added
[ ] ~CHANGELOG entry added~ n/a