docs: add terraform to mkdocs

Ref: #1987
jef · Feb 23, 2021 · 488bc54 · 488bc54
1 parent d341ef7
commit 488bc54
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -16,7 +16,7 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           release-type: simple
-          changelog-path: docs/changelog.md
+          changelog-path: CHANGELOG.md
           package-name: streetmerchant
       - name: Login into GitHub Container Registry
         if: ${{ steps.release.outputs.release_created }}

diff --git a/docs/reference/terraform.md b/docs/reference/terraform.md
@@ -0,0 +1 @@
+../../terraform/README.md
diff --git a/terraform/README.md b/terraform/README.md
@@ -1,15 +1,16 @@
 # Terraform for AWS Fargate
 
-Here's some configurable terraform to get you up and running with the streetmerchant docker image in AWS ECS Fargate.
+Here is a configurable terraform to get you up and running with the streetmerchant docker image in AWS ECS Fargate.
 
-Running on cloud infrastructure, your mileage may vary, and you'll need to integrate with one of the chat notifications rather than having your local browser navigate to a url for you.
+Running on cloud infrastructure (your mileage may vary), you'll need to integrate with one of the chat notifications rather than having your local browser navigate to a URL for you.
 
-The author's findings were that it worked ok; running the container from within EU-West-2 region was suficient to get a timely alert for PS5 stock on amazon, and follow the link to a successful basket add.
+The author's findings were that it worked ok; running the container from within EU-West-2 region was sufficient to get a timely alert for PS5 stock on Aamzon and follow the link to a successful checkout.
 
 Dependencies:
+
 - Terraform 14
 
-##Getting started
+## Getting started
 
 There's an example tfvars file to start you off; rename this with your own preferences.  Anything you can set in the `dotenv` file you'll need to set in terraform.tfvars to get the env vars into your fargate container.
 
@@ -18,6 +19,7 @@ Authenticate yourself with your own AWS account as with any aws commandline tool
 If you wish, add a specific section to your aws credentials file and set that profile name in `terraform.tfvars`.
 
 Then you can:
+
 ```shell
 cd ./terraform
 terraform init
@@ -28,5 +30,5 @@ terraform apply
 
 ## What's included
 
-- container, running streetmerchant, with your chosen config
+- container running streetmerchant with your chosen config
 - cloud metrics and a dashboard tracking 'out of stock' and 'error' responses from your configured stores