DOC: More updates on README.md

modules/networking/VpcSubnet/README.md

@@ -1,4 +1,3 @@
-<!-- This readme file is generated with terraform-docs -->
 This module performs the following tasks:
 
 - Create VPC, vpcflow log
@@ -6,6 +5,7 @@ This module performs the following tasks:
 - Create IGW, NGW
 - Create s3 and ddb endpoints which are free
 
+
 ## Requirements
 
 | Name | Version |
@@ -59,9 +59,9 @@ This module performs the following tasks:
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| create-free-vpc-endpoints | n/a | `bool` | `true` | no |
-| create-nat-gateway | n/a | `bool` | `false` | no |
-| enable-flow-log | n/a | `bool` | `true` | no |
+| create-free-vpc-endpoints | Whether to deploy free VPC endpoints (s3 and dynamodb) | `bool` | `true` | no |
+| create-nat-gateway | Deploy NAT gateway for private subnets | `bool` | `false` | no |
+| enable-flow-log | Whether to enable VPC flowlog | `bool` | `true` | no |
 | flow-log-bucket-arn | Arn of S3 bucket to be used for flow logging | `string` | `null` | no |
 | flow-log-destination | Destination of flowlog. Valid destinations are s3 or cwlog | `string` | `null` | no |
 | multiaz-nat-gateway | Whether to deploy 1 NAT gateway for each AZ | `bool` | `false` | no |

modules/networking/VpcSubnet/variables.tf

@@ -22,6 +22,7 @@ variable "public-subnet-cidrs" {
 }
 
 variable "create-nat-gateway" {
+  description = "Deploy NAT gateway for private subnets"
   type        = bool
   default     = false
 }
@@ -45,6 +46,7 @@ variable "flow-log-bucket-arn" {
 }
 
 variable "enable-flow-log" {
+  description = "Whether to enable VPC flowlog"
   type        = bool
   default     = true
 }
@@ -61,6 +63,7 @@ variable "vpcflowlog-cwl-loggroup-key-arn" {
 }
 
 variable "create-free-vpc-endpoints" {
+  description = "Whether to deploy free VPC endpoints (s3 and dynamodb)"
   type    = bool
   default = true
 }