From 009e7c65579d033d02b56e8424708f8d03170b1f Mon Sep 17 00:00:00 2001
From: Veronika Gnilitska <veronika.gnilitska@gmail.com>
Date: Thu, 12 Dec 2024 06:41:12 -0500
Subject: [PATCH] chore: fix typos + address PR feedback

---
 README.md                      | 18 +-----------------
 root-module/README.md          | 10 ++++------
 terraform-random-pet/README.md |  4 ++--
 3 files changed, 7 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index ff31034..d39a69f 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@ We recommend to include:
 
 ## Module Repository/Directory Structure
 
-Below is a recommended structure for both Terraform child modules and root modules. Inside each file, you’ll find guidance and best practices that help maintain clarity and consistency across your infrastructure code.
+Below is a recommended structure for both TF child modules and root modules. Inside each file, you’ll find guidance and best practices that help maintain clarity and consistency across your infrastructure code.
 
 ```sh
 .
@@ -37,19 +37,3 @@ Below is a recommended structure for both Terraform child modules and root modul
 
 - Testing and Examples: Consider adding an examples/ directory with sample configurations and a test/ directory (if using tools like terratest or native Terraform testing) to ensure the module works as intended
 - Continuous Improvement: Update documentation and constraints (versions.tf) as Terraform and providers evolve, and as you refine the module’s functionality.
-
-<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
-## Requirements
-
-## Providers
-
-## Modules
-
-## Resources
-
-## Inputs
-
-## Outputs
-
-<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/root-module/README.md b/root-module/README.md
index 941f149..392e8f7 100644
--- a/root-module/README.md
+++ b/root-module/README.md
@@ -1,13 +1,11 @@
 # root-module
 
-This is a dummy root module.
+This is a template root module.
 
-## Recommenations (DO NOT INCLUDE THIS INTO THE REAL README)
+## Documentation Recommendations (DO NOT INCLUDE THIS INTO THE REAL README)
 
-- Nodule description: Briefly explain what the root module sets up (e.g., infrastructure for a production environment).
-- Usage instructions: Include examples of how to run terraform init, terraform plan, and terraform apply.
-- Documentation of variables and outputs: generate variables (from variables.tf) and outputs (from outputs.tf).
-- Link to child modules and external resources: If the root module references child modules, mention where they’re located and link to their documentation.
+- Module description: Briefly explain what the root module sets up (e.g., infrastructure for RDS Postgres instances).
+- Use [terraform-docs](https://github.com/terraform-docs/terraform-docs) to ensure that variables, outputs, child module, and resource documentation is included.
 - Maintain current information: Keep the README updated as the infrastructure evolves.
 
 ## Structure
diff --git a/terraform-random-pet/README.md b/terraform-random-pet/README.md
index 8637905..3a65383 100644
--- a/terraform-random-pet/README.md
+++ b/terraform-random-pet/README.md
@@ -1,8 +1,8 @@
 # terraform-random-pet
 
-This is a dummy child module.
+This is a template child module.
 
-## Recommenations (DO NOT INCLUDE THIS INTO THE REAL README)
+## Documentation Recommendations (DO NOT INCLUDE THIS INTO THE REAL README)
 
 ### Naming