Add tfdocs link to all READMEs

aks/application/README.md

@@ -2,6 +2,9 @@
 
 Terraform code for deploying an application.
 
+## Terraform documentation
+For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs).
+
 ## Usage
 
 ```terraform

aks/application_configuration/README.md

@@ -2,6 +2,9 @@
 
 Terraform code for generating the application configuration.
 
+## Terraform documentation
+For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs).
+
 ## Usage
 
 ```terraform
@@ -34,9 +37,9 @@ RAILS_LOG_TO_STDOUT=true
 
 Secrets are automatically extracted from an Azure Key Vault using the [AKS Secrets](../secrets) module and exposed to the application via environment variables.
 
-**Azure Key Vault doesn't allow keys with underscores and environment variable names can't have dashes, so dashes are automatically replaced with underscores before being exposed as environment variables.** 
+**Azure Key Vault doesn't allow keys with underscores and environment variable names can't have dashes, so dashes are automatically replaced with underscores before being exposed as environment variables.**
 
-The short name of the key vault can be customised by setting `secret_key_vault_short`, usually this should either be `null` or set to `"app"`. Any dashes in the keys are automatically converted to underscores. 
+The short name of the key vault can be customised by setting `secret_key_vault_short`, usually this should either be `null` or set to `"app"`. Any dashes in the keys are automatically converted to underscores.
 
 If your application still has an old-style YAML secret in the key vault, this module can be used to extract the values from it by setting the `secret_yaml_key` variable.
 

aks/cluster_data/README.md

@@ -2,6 +2,9 @@
 
 Terraform module for managing information about the cluster.
 
+## Terraform documentation
+For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs).
+
 ## Usage
 
 ```terraform

aks/dfe_analytics/README.md

@@ -1,6 +1,9 @@
 # DfE Analytics
 Create resources in Google cloud Bigquery and provides the required variables to applications so they can send events.
 
+## Terraform documentation
+For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs).
+
 ## Usage
 ### Reuse existing dataset and events table
 

aks/postgres/README.md

@@ -2,6 +2,9 @@
 
 Terraform code for deploying a PostgreSQL instance.
 
+## Terraform documentation
+For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs).
+
 ## Usage
 
 ```terraform

aks/redis/README.md

@@ -2,6 +2,9 @@
 
 Terraform code for deploying a Redis instance.
 
+## Terraform documentation
+For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs).
+
 ## Usage
 
 ```terraform
@@ -38,4 +41,4 @@ The URL of the Redis instance.
 
 ### `connection_string`
 
-A connection string that's compatible with .NET applications to the Redis instance.
+A connection string that's compatible with .NET applications to the Redis instance.

aks/secrets/README.md

@@ -2,6 +2,9 @@
 
 Terraform code for extracting secrets from Azure Key Vaults.
 
+## Terraform documentation
+For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs).
+
 ## Usage
 
 ```terraform

dns/records/readme.md

@@ -1,3 +1,6 @@
 # DNS records
 
 Terraform code for managing Azure DNS records.
+
+## Terraform documentation
+For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs).

dns/zones/readme.md

@@ -1,3 +1,6 @@
 # DNS Zones
 
 Terraform code for managing Azure DNS Zones.
+
+## Terraform documentation
+For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs).

domains/environment_domains/README.md

@@ -0,0 +1,6 @@
+# Environment domains
+
+Create domains for each environment in the [domains infrastructure](../infrastructure/). Generates the DNS records as well as front door domain, endpoint, route, origin, redirect rules...
+
+## Terraform documentation
+For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs).

domains/infrastructure/README.md

@@ -0,0 +1,6 @@
+# Domains infrastructure
+
+Create DNS zone, front door and the default DNS records that will be used to support the service domains of each environment, using the [environment_domains module](../environment_domains/README).
+
+## Terraform documentation
+For the list of requirement, inputs, outputs, resources... check the [terraform module documentation](tfdocs).