docs: add guidance on including ec2 instance tags within custom domain name (#104)

Author: purpleclay

.github/workflows/docs.yml

@@ -62,7 +62,7 @@ jobs:
           path: site
           config: htmltest.yml
 
-      - name: Patch mkdocs.yml
+      - name: Patch mkdocs.yml Site URL
         if: startsWith(github.ref, 'refs/tags/v')
         uses: jacobtomlinson/gha-find-replace@v2
         with:
@@ -71,6 +71,15 @@ jobs:
           regex: false
           include: mkdocs.yml
 
+      - name: Patch mkdocs.yml Edit URI
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: jacobtomlinson/gha-find-replace@v2
+        with:
+          find: 'edit_uri: ""'
+          replace: 'edit_uri: "edit/main/docs"'
+          regex: false
+          include: mkdocs.yml
+
       - name: Deploy documentation
         if: startsWith(github.ref, 'refs/tags/v')
         env:

cmd/root.go

@@ -44,7 +44,7 @@ import (
 )
 
 const (
-	longDesc = `Dynamic DNS within Amazon Route 53. Expose your EC2 quickly, easily and privately within a Route 
+	longDesc = `Dynamic DNS within Amazon Route 53. Expose your EC2 quickly, easily, and privately within a Route 
 53 Private Hosted Zone (PHZ).
 
 Your EC2 will be exposed through a dynamically generated resource record that will automatically 

cmd/tag.go

@@ -36,7 +36,7 @@ import (
 func newTagsCommand(out io.Writer) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:           "tags",
-		Short:         "Lists all available EC2 instance tags and how they can be used with Go templating",
+		Short:         "Lists all available EC2 instance tags and how to use them with Go templating",
 		Args:          cobra.NoArgs,
 		SilenceUsage:  true,
 		SilenceErrors: true,

docs/configure/broadcast-ec2.md

@@ -1,4 +1,5 @@
 ---
+description: "Broadcasting your EC2 privately within your VPC couldn't be easier"
 icon: material/bullhorn-variant-outline
 ---
 

docs/configure/custom-domain.md

@@ -1,4 +1,5 @@
 ---
+description: "Learn how to customise your EC2 domain name when privately broadcasting your instance"
 icon: material/web
 ---
 

docs/configure/exposing-tags.md

@@ -1,4 +1,5 @@
 ---
+description: "Expand your domain name customisation options by exposing your EC2 instance tags"
 icon: material/tag-outline
 status: new
 ---

docs/configure/iam.md

@@ -1,4 +1,5 @@
 ---
+description: "Understand what Identity Access Management (IAM) permissions are needed for dns53 to run"
 icon: material/shield-lock-outline
 ---
 

docs/configure/list-tags.md

@@ -0,0 +1,13 @@
+---
+description: "Generate a cheat sheet on how to include EC2 instance tags within your custom domain name"
+icon: material/tag-search-outline
+status: new
+---
+
+# List Available EC2 Instance Tags
+
+To generate a cheat sheet for including EC2 instance tags within a custom domain using Go templating, run the following command:
+
+```sh
+dns tags
+```

docs/reference/cli/dns53-imds.md

@@ -1,4 +1,5 @@
 ---
+description: "Learn how to use the DNS 53 command line to toggle IMDS features"
 icon: material/console
 ---
 

docs/reference/cli/dns53-tags.md

@@ -0,0 +1,27 @@
+---
+description: "Learn how to use the DNS 53 command line to list available EC2 instance tags"
+icon: material/console
+---
+
+# Command Line
+
+Lists all available EC2 instance tags and how to use them with Go templating
+
+## Usage
+
+```text
+dns53 tags [flags]
+```
+
+## Flags
+
+```text
+-h, --help   help for tags
+```
+
+## Global Flags
+
+```text
+--profile string   the AWS named profile to use when loading credentials
+--region string    the AWS region to use when querying AWS
+```