update doc

terraform-modules · Mar 16, 2021 · 598b181 · 598b181
1 parent b732720
commit 598b181
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 12 deletions.
diff --git a/ses-domain/README.md b/ses-domain/README.md
@@ -3,7 +3,11 @@
 This sets up the domain identity for SES.  We create by default `{account_id}.aws.mail.census.gov`  
 as a sender domain, and generate the details which are to be submitted to TCO for inclusion in DNS.  
 The contents of the file `setup/ses_dns.md` contain the text which goes to TCO.  A future enhancement  
-to this will include the ability to automatically incorporate the changes into DNS.
+to this will include the ability to automatically incorporate the changes into DNS.  This is a multi-step  
+setup:
+# Create initial resources
+# Provide TCO Details for DNS Update
+# Complete domain validation
 
 ## Select proper region
 
@@ -42,8 +46,16 @@ module "ses" {
   ses_base_dkim_domain_name = "dkim.amazonses.com"
 }
 ```
+## Create initial resources
+```console
+% tf-apply -target=module.ses
+```
+
+## Provide TCO DNS details
 
-# After DNS is updated  
+See and exmaple [ses\_dns.md](example.ses\_dns.md).  This file will be in `setup/ses_dns.md`.  Submit this to TCO to get the records added to DNS.
+
+## After DNS is updated  
 Once DNS has been updated, you can run `tf-apply` on the resource again.  It will look for a non-empty value  
 for the TXT record and if so, complete the validation process.  Here is an example:
 ```console
@@ -84,10 +96,6 @@ ses_domain_verification = {
 }
 ```
 
-# Sample ses\_dns.md output
-
-See [ses\_dns.md](example.ses\_dns.md).
-
 ## Requirements
 
 No requirements.

diff --git a/ses-domain/main.tf b/ses-domain/main.tf
@@ -4,7 +4,11 @@
 * This sets up the domain identity for SES.  We create by default `{account_id}.aws.mail.census.gov`
 * as a sender domain, and generate the details which are to be submitted to TCO for inclusion in DNS.
 * The contents of the file `setup/ses_dns.md` contain the text which goes to TCO.  A future enhancement
-* to this will include the ability to automatically incorporate the changes into DNS.
+* to this will include the ability to automatically incorporate the changes into DNS.  This is a multi-step
+* setup:
+* # Create initial resources
+* # Provide TCO Details for DNS Update
+* # Complete domain validation
 * 
 * ## Select proper region
 *
@@ -43,8 +47,16 @@
 *   ses_base_dkim_domain_name = "dkim.amazonses.com"
 * }
 * ```
+* ## Create initial resources
+* ```console
+* % tf-apply -target=module.ses
+* ```
+*
+* ## Provide TCO DNS details
 *
-* # After DNS is updated
+* See and exmaple [ses_dns.md](example.ses_dns.md).  This file will be in `setup/ses_dns.md`.  Submit this to TCO to get the records added to DNS.
+*
+* ## After DNS is updated
 * Once DNS has been updated, you can run `tf-apply` on the resource again.  It will look for a non-empty value
 * for the TXT record and if so, complete the validation process.  Here is an example:
 * ```console
@@ -84,10 +96,6 @@
 *   "value" = "/Pz6+wpIUfumhdG8l0NkdfLx+wHMp+/Za2Nf5jOQTos="
 * }
 * ```
-*
-* # Sample ses_dns.md output
-*
-* See [ses_dns.md](example.ses_dns.md).
 */
 
 locals {