fix grammar and expression error

mauricenyanja · Aug 31, 2020 · c331d7c · c331d7c
1 parent ee8e11b
commit c331d7c
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 9 deletions.
diff --git a/aws-ts-netlify-cms-and-oauth/cms-oauth/.github/workflows/build-and-deploy.yml b/aws-ts-netlify-cms-and-oauth/cms-oauth/.github/workflows/build-and-deploy.yml
@@ -24,6 +24,8 @@ jobs:
  - name: Preview infrastructure
  if: ${{ github.event_name == 'pull_request' }}
  env:
+ # Setting AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN is optional
+ # in case your organization's AWS setup requires it
  AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
  AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
  AWS_SESSION_TOKEN: ${{ secrets.AWS_SESSION_TOKEN }}
@@ -35,6 +37,8 @@ jobs:
  - name: Deploy infrastructure
  if: ${{ github.event_name == 'push' }}
  env:
+ # Setting AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN is optional
+ # in case your organization's AWS setup requires it
  AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
  AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
  AWS_SESSION_TOKEN: ${{ secrets.AWS_SESSION_TOKEN }}

diff --git a/aws-ts-netlify-cms-and-oauth/cms-oauth/Dockerfile b/aws-ts-netlify-cms-and-oauth/cms-oauth/Dockerfile
@@ -2,7 +2,7 @@
 FROM golang:1.13-alpine3.12 as buildenv
 RUN apk add --no-cache build-base git
 
-WORKDIR /go/src/github.com/zephyrz73/aws-ts-netlify-cms-and-oauth/cms-oauth
+WORKDIR /go/src/github.com/pulumi/aws-ts-netlify-cms-and-oauth/cms-oauth
 COPY ./ ./
 RUN go mod download
 

diff --git a/aws-ts-netlify-cms-and-oauth/cms/README.md b/aws-ts-netlify-cms-and-oauth/cms/README.md
@@ -1,5 +1,4 @@
 
-# TRY PULUMI'S CMS AT http:https://cms.corptron9000.pulumi.com/
 ## Background Knowledges
 CMS stands for content management system, which facilitate creation and modification of digital content.
 
@@ -16,7 +15,7 @@ Special thanks to the template provided by [@talves](https://github.com/ADARTA/n
 ## File Path
 
 - .github/workflow
- - The implementation of Github Actions and Github Workflow
+ - The implementation of Github Actions workflow
 - cms/infrastructure
  - The infrastructure of deploying cms app on AWS using Pulumi.
  - index.ts contain the code for the Pulumi program
@@ -31,7 +30,7 @@ Special thanks to the template provided by [@talves](https://github.com/ADARTA/n
 
 ## Infrastructure
 
-The infrastructure folder contain Pulumi code of deploying this CMS app onto the AWS S3, speeding up using AWS CloudFront, and certificate creation using AWS Certificate Manager. The general idea is deploy the CMS application as a static website onto the AWS. We already have a [Pulumi's static website creation example](https://github.com/pulumi/examples/tree/master/aws-ts-static-website) with explaination provided.
+The infrastructure folder contain Pulumi code of deploying this CMS app onto the AWS S3, speeding up using AWS CloudFront, and certificate creation using AWS Certificate Manager. The general idea is deploy the CMS application as a static website onto the AWS. We already have a [Pulumi's static website creation example](https://github.com/pulumi/examples/tree/master/aws-ts-static-website) with explanation provided.
 
 The infrastructure takes three argument: pathToWebsiteContents,targetDomain, certificateArn.
 - pathToWebsiteContents
@@ -142,17 +141,17 @@ $ pulumi up
 - add tag to the commit says "drafts"
 - produce a card at the drafts column on the editorial workflow page (mentioned in 5. 6.)
 
-5. Click Back Button would go back to collection page and click Workflow button would bring out the editorial workflow
+5. Click the Back button to go back to the collections page and clicking the **Workflow** button would bring out the editorial workflow
 
  ![workflow button](Readme-Screenshots/Workflow_button.jpg)
 
  ![Editorial Workflow](Readme-Screenshots/Editorial_Workflow.jpg)
 
-6. Move a change card from "Drafts" column to "In Review" column would remove "draft" tag of the commit on docs repo and create an "in-review" tag to the commits in docs repo 
+6. Moving a card from the "Drafts" column to the "In Review" column will remove the "draft" tag and apply an "in-review" tag on the PR
 
-7. Move a change card from "In Review" to "Ready" columns would change the commit tag to "ready"
+7. Similarly, moving a card from "In Review" to "Ready" columns would change the PR tag to "ready"
 
-8. Hover on the card in "Ready" column would show "publish change" button, which would merge the branch into the master branch.
+8. Hover on the card in "Ready" column would show **Publish change** button, which would merge the PR.
 
 
 

diff --git a/aws-ts-netlify-cms-and-oauth/cms/infrastructure/index.ts b/aws-ts-netlify-cms-and-oauth/cms/infrastructure/index.ts
@@ -49,7 +49,7 @@ function crawlDirectory(dir: string, f: (_: string) => void) {
  }
 }
 
-// Sync the contents of the source directory with the S3 bucket, which will in-turn show up on the CDN.
+// Sync the contents of the build directory with the S3 bucket, which will in-turn show up on the CDN. This method of uploading objects to S3 is idea for small apps that contain less than 100 files.
 const webContentsRootPath = path.join(process.cwd(), config.pathToWebsiteContents);
 console.log("Syncing contents from local disk at", webContentsRootPath);
 crawlDirectory(