adding terraform-docs

UKHomeOffice · Oct 29, 2024 · 5b0bb22 · 5b0bb22
1 parent 08b1e4b
commit 5b0bb22
Show file tree

Hide file tree

Showing 10 changed files with 13 additions and 430 deletions.
diff --git a/modules/aws/networking/alb/README.md b/modules/aws/networking/alb/README.md
@@ -0,0 +1,12 @@
+<!-- BEGIN_TF_DOCS -->
+header: |
+  # My Terraform Module
+
+  This module provisions resources for ...
+  _(Brief description of the module's purpose)_
+
+footer: |
+  ## Contributing
+
+  Contributions are welcome! Please create a pull request or open an issue for suggestions and improvements.
+<!-- END_TF_DOCS -->
diff --git a/modules/aws/networking/alb/terraform-docs.yml b/modules/aws/networking/alb/terraform-docs.yml
@@ -6,7 +6,7 @@ output:
   file: README.md
   mode: inject
 
-content:
+content: |
   header: |
     # My Terraform Module
 
@@ -44,7 +44,6 @@ settings:
     - footer
 
 templates:
-  # Customize formatting for specific sections
   inputs: |
     ## Inputs
 

diff --git a/modules/aws/networking/central-ingress-alb/main.tf b/modules/aws/networking/central-ingress-alb/main.tf
diff --git a/modules/aws/networking/central-ingress-alb/outputs.tf b/modules/aws/networking/central-ingress-alb/outputs.tf
diff --git a/modules/aws/networking/central-ingress-alb/sg.tf b/modules/aws/networking/central-ingress-alb/sg.tf
diff --git a/modules/aws/networking/central-ingress-alb/variables.tf b/modules/aws/networking/central-ingress-alb/variables.tf
diff --git a/modules/aws/networking/central-ingress-nlb/main.tf b/modules/aws/networking/central-ingress-nlb/main.tf
diff --git a/modules/aws/networking/central-ingress-nlb/outputs.tf b/modules/aws/networking/central-ingress-nlb/outputs.tf
diff --git a/modules/aws/networking/central-ingress-nlb/sg.tf b/modules/aws/networking/central-ingress-nlb/sg.tf