From 6c39dcfd7b0df7f48b6a18eb699de75282c70705 Mon Sep 17 00:00:00 2001 From: Jeremy Frasier Date: Tue, 5 Dec 2023 12:12:57 -0500 Subject: [PATCH] Add terraform-docs injection headers to example README.md We also symlink the .terrafrom-docs.yml file from the root of the repo. --- examples/basic_usage/.terraform-docs.yml | 1 + examples/basic_usage/README.md | 2 ++ 2 files changed, 3 insertions(+) create mode 120000 examples/basic_usage/.terraform-docs.yml diff --git a/examples/basic_usage/.terraform-docs.yml b/examples/basic_usage/.terraform-docs.yml new file mode 120000 index 0000000..2afdcf8 --- /dev/null +++ b/examples/basic_usage/.terraform-docs.yml @@ -0,0 +1 @@ +../../.terraform-docs.yml \ No newline at end of file diff --git a/examples/basic_usage/README.md b/examples/basic_usage/README.md index d36960e..d120104 100644 --- 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. + ## 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. | +