Add terraform-docs injection headers to example README.md

We also symlink the .terrafrom-docs.yml file from the root of the repo.
cisagov · Dec 5, 2023 · 6c39dcf · 6c39dcf
1 parent ca595f9
commit 6c39dcf
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/examples/basic_usage/.terraform-docs.yml b/examples/basic_usage/.terraform-docs.yml
@@ -0,0 +1 @@
+../../.terraform-docs.yml
diff --git a/examples/basic_usage/README.md b/examples/basic_usage/README.md
@@ -8,6 +8,7 @@ followed by the `terraform apply` command.
 Note that this example may create resources which cost money. Run
 `terraform destroy` when you no longer need these resources.
 
+<!-- BEGIN_TF_DOCS -->
 ## Requirements ##
 
 | Name | Version |
@@ -53,3 +54,4 @@ Note that this example may create resources which cost money. Run
 | id | The EC2 instance ID. |
 | private\_ip | The private IP of the EC2 instance. |
 | subnet\_id | The ID of the subnet where the EC2 instance is deployed. |
+<!-- END_TF_DOCS -->