edits part 1 010521

censullo · censullo · commit 3195e23f9c3b · 2021-01-05T11:23:10.000-05:00
diff --git a/docs/partner_editable/_settings.adoc b/docs/partner_editable/_settings.adoc
@@ -14,7 +14,7 @@
 // and "{quickstart-team-name}". Use commas as shown in the placeholder text. 
 // Use the comma before "and" only when three or more names.
 // :partner-contributors: Shuai Ye, Michael McConnell, and John Smith, {partner-company-name}
-:quickstart-contributors: Kirankumar Chandrashekar and Jay McConnell, Amazon Web Services
+:quickstart-contributors: Kirankumar Chandrashekar and Jay McConnell, AWS Quick Start team
 // For deployment_time, use minutes if deployment takes an hour or less, 
 // for example, 30 minutes or 60 minutes. 
 // Use hours for deployment times greater than 60 minutes (rounded to a quarter hour),
diff --git a/docs/partner_editable/additional_info.adoc b/docs/partner_editable/additional_info.adoc
@@ -18,14 +18,14 @@ The instructions for setting up webhooks and deployment keys vary by Git service
 
 After deploying the Quick Start, configure the AWS services in your workload to use the Git repository S3 bucket as a source. 
 
-As shown in <<outputs_tab>>, the *Outputs* tab in the AWS CloudFormation console includes *OutputBucketName*. This output is an S3 key that forms the base of the path to the .zip file of your repository code. The S3 key is in the following format:
+As shown in <<outputs_tab>>, the *Outputs* tab in the AWS CloudFormation console includes *OutputBucketName*. This output is an Amazon S3 key that forms the base of the path to the .zip file of your repository code. The S3 key has the following format:
 
 ```
 S3://output-bucket-name/git-user/git-repository/git-user_git-repository.zip
 ```
 Here, `git-user` is the owner or path prefix of the repository. In some Git services, this may be an organization name. However, some Git services do not return a Git user or organization for a repository. In these cases, you can omit the `git-user` parts of the path.
 
-The instructions for linking an AWS service to an S3 object vary. For links to AWS service documentation, see link:#_aws_services[AWS services] later in this guide.
+The instructions vary for linking an AWS service to an Amazon S3 object. For links to AWS service documentation, see link:#_aws_services[AWS services], later in this guide.
 
 == Adding an API secret after deployment
 
@@ -38,7 +38,7 @@ To update the stack with an API secret, do the following:
 . Choose *Use current template*.
 . On the *Specify stack details* page, change the *API Secret* parameter setting, then choose *Next*.
 . On the *Configure stack options* page, choose *Next*.
-. Choose *I acknowledge that this template may create IAM resources*.
+. Select *I acknowledge that this template may create IAM resources*.
 . Choose *Update stack*. When the status is *UPDATE_COMPLETE*, the stack is updated with the API secret.
 
 == Test the deployment
@@ -47,7 +47,7 @@ Before putting a webhook into production, test your deployment by doing the foll
 
 . Modify a file in your repository.
 . Commit and push the changes.
-. Wait a few minutes, then check the Git repository S3 bucket this Quick Start deploys for a new (or updated) object with a key that matches your repository path.
+. Wait a few minutes, and then check the Git repository S3 bucket for a new (or updated) object with a key that matches your repository path.
 
 :xrefstyle: short
 [#S3_new_object]
@@ -59,14 +59,14 @@ image::../images/S3_new_object.png[S3_new_object,width=646,height=348]
 
 The architecture built by this Quick Start supports AWS best practices for security.
 
-=== SSH Keys
+=== SSH keys
 
-This Quick Start deploys a private SSH key pair which is encrypted with an AWS KMS key and uploaded to Amazon S3. CodeBuild decrypts the private SSH key and uses it to authenticate your Git service before cloning the repository.
+This Quick Start deploys a private SSH key pair that is encrypted with an AWS KMS key and uploaded to Amazon S3. AWS CodeBuild decrypts the private SSH key and uses it to authenticate your Git service before cloning the repository.
 
 We don’t recommend sharing SSH keys among multiple services, or launching another instance of this Quick Start to clone and store another repository in Amazon S3. Each repository should use unique SSH keys.
 
 === Webhook security
 
-Git services provide different ways to authenticate against an endpoint, such as webhook secrets, source IP address whitelisting, personal access tokens, and OAuth2. We recommend that you set up at least one of these security mechanisms to protect your webhook API endpoint. 
+Git services provide different ways to authenticate an endpoint, such as webhook secrets, source-IP-address allow listing, personal access tokens, and OAuth2. We recommend that you set up at least one of these security mechanisms to protect your webhook API endpoint. 
 
-For more information about how this Quick Start utilizes endpoint security mechanisms, see the link:#_parameter_reference[Parameter reference] section of this guide. For specific guidance on how to configure security mechanisms for your Git service, refer to your Git service documentation.
+For more information about how this Quick Start uses endpoint security mechanisms, see the link:#_parameter_reference[Parameter reference] section of this guide. For specific guidance on how to configure security mechanisms for your Git service, refer to your Git service documentation.
diff --git a/docs/partner_editable/architecture.adoc b/docs/partner_editable/architecture.adoc
@@ -12,13 +12,13 @@ As shown in <<architecture_diagram>>, this Quick Start sets up a serverless AWS
 
 * Amazon API Gateway to receive Git webhook requests and forward them to AWS Lambda.
 * An AWS Lambda function to process Git webhook requests from API Gateway and invoke an AWS CodeBuild project.
-* A CodeBuild project to connect to your Git service, then retrieve, zip, and upload the latest version of your Git repository to Amazon S3.
-* An AWS Key Management Service (AWS KMS) key to encrypt/decrypt the SSH (Secure Shell) keys used by CodeBuild to connect to your Git repository using SSH. The SSH key pair is generated by a Lambda-backed AWS CloudFormation custom resource when the stack is deployed.
+* A AWS CodeBuild project to connect to your Git service, then retrieve, zip, and upload the latest version of your Git repository to Amazon S3.
+* An AWS Key Management Service (AWS KMS) key to encrypt/decrypt the SSH (Secure Shell) keys used by AWS CodeBuild to connect to your Git repository using SSH. The SSH key pair is generated by a Lambda-backed AWS CloudFormation custom resource when the stack is deployed.
 * Two Amazon S3 buckets: one for Git repository contents, and another for encrypted SSH keys. A Lambda-backed AWS CloudFormation custom resource deletes the contents of the S3 buckets when you delete the CloudFormation stack. If you need backups, ensure that you copy the S3 buckets before deleting the stack.
 
 [NOTE]
 ========
 * The Quick Start deploys AWS Identity and Access Management (IAM) roles required by Lambda and API Gateway. The inline permissions attached to the roles are scoped using the http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege[least privilege] model.
-* The CodeBuild project must be able to communicate with your Git repository. For example, you can employ a SaaS-based Git service like GitHub to which CodeBuild can connect over the internet.
+* The AWS CodeBuild project must be able to communicate with your Git repository. For example, you can employ a SaaS-based Git service like GitHub to which CodeBuild can connect over the internet.
 * The Git repository S3 bucket this Quick Start deploys has versioning enabled, and all previous versions are retained indefinitely. To modify the retention period, see http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html[How do I create a lifecycle rule for an S3 bucket?]
 ========
diff --git a/docs/partner_editable/faq_troubleshooting.adoc b/docs/partner_editable/faq_troubleshooting.adoc
@@ -8,17 +8,17 @@
 
 WARNING: When you set *Rollback on failure* to *Disabled*, you continue to incur AWS charges for this stack. Ensure that you delete the stack after troubleshooting.
 
-For additional information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html[Troubleshooting AWS CloudFormation^] on the AWS website.
+For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html[Troubleshooting AWS CloudFormation^].
 
 == Troubleshooting
 
 If commits to your repository do not show up in Amazon S3, do the following:
 
-* Check the security parameters and endpoint in your Git webhook configuration. See link:#_configuring_git_services[Configuring Git services] earlier in this guide and consult your Git service documentation for help configuring webhooks.
-* Check the Lambda logs for errors. These are stored in Amazon CloudWatch Logs. For help accessing them, see https://docs.aws.amazon.com/lambda/latest/dg/monitoring-cloudwatchlogs.html[Accessing Amazon CloudWatch logs for AWS Lambda].
+* Check the security parameters and endpoint in your Git webhook configuration. See link:#_configuring_git_services[Configuring Git services] earlier in this guide and consult your Git service documentation for help with configuring webhooks.
+* Check the AWS Lambda logs for errors. These are stored in Amazon CloudWatch Logs. For help with accessing them, see https://docs.aws.amazon.com/lambda/latest/dg/monitoring-cloudwatchlogs.html[Accessing Amazon CloudWatch logs for AWS Lambda].
 * Check the AWS CodeBuild project logs for errors. To access them, do the following:
 . Open the AWS CodeBuild console. 
-. On the *Build history* page, click the *Build run* link for the project.
+. On the *Build history* page, choose the *Build run* link for the project.
 . On the *Build status* page, see the *Build logs* tab.
 
 == Additional resources
@@ -38,6 +38,6 @@ If commits to your repository do not show up in Amazon S3, do the following:
 
 === Webhooks
 
-* https://developer.github.com/v3/repos/hooks/[Webhooks on GitHub Developer blog]
-* https://confluence.atlassian.com/bitbucket/manage-webhooks-735643732.html[Manage webhooks on Atlassian Bitbucket Support]
-* https://docs.gitlab.com/ce/user/project/integrations/webhooks.html[Webhooks on GitLab Docs]
+* https://developer.github.com/v3/repos/hooks/[GitHub Docs: Webhooks]
+* https://confluence.atlassian.com/bitbucket/manage-webhooks-735643732.html[BitBucket Support: Manage webhooks]
+* https://docs.gitlab.com/ce/user/project/integrations/webhooks.html[GitLab Docs: Webhooks]
diff --git a/docs/partner_editable/product_description.adoc b/docs/partner_editable/product_description.adoc
@@ -1,3 +1,3 @@
-After deploying this Quick Start and configuring a webhook in your Git service, when a Git user pushes changes to your repository, the Git service sends an HTTPS POST request to the HTTPS endpoint. The HTTPS POST request contains JavaScript Object Notation (JSON) data about the push operation and repository. After the request is accepted by Amazon API Gateway, it is passed to an AWS Lambda function that triggers an AWS CodeBuild project. The CodeBuild project retrieves the latest version of your repository, zips it, and uploads it to an Amazon S3 bucket. 
+After deploying the Quick Start, you use the link:#_configuring_git_services[endpoint information] it provides to configure a webhook in your Git service. A webhook sends an HTTPS POST request to the endpoint in response to a push action. The HTTPS POST request contains JavaScript Object Notation (JSON) data about the push and repository. After the request is accepted by Amazon API Gateway, it is passed to an AWS Lambda function that triggers an AWS CodeBuild project. The AWS CodeBuild project uses the information in the HTTPS POST request to retrieve the latest version of your repository.
 
 For more information about the components that this Quick Start deploys, see the link:#_architecture[Architecture] section later in this guide.

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		-After deploying this Quick Start and configuring a webhook in your Git service, when a Git user pushes changes to your repository, the Git service sends an HTTPS POST request to the HTTPS endpoint. The HTTPS POST request contains JavaScript Object Notation (JSON) data about the push operation and repository. After the request is accepted by Amazon API Gateway, it is passed to an AWS Lambda function that triggers an AWS CodeBuild project. The CodeBuild project retrieves the latest version of your repository, zips it, and uploads it to an Amazon S3 bucket.
	`1`	+After deploying the Quick Start, you use the link:#_configuring_git_services[endpoint information] it provides to configure a webhook in your Git service. A webhook sends an HTTPS POST request to the endpoint in response to a push action. The HTTPS POST request contains JavaScript Object Notation (JSON) data about the push and repository. After the request is accepted by Amazon API Gateway, it is passed to an AWS Lambda function that triggers an AWS CodeBuild project. The AWS CodeBuild project uses the information in the HTTPS POST request to retrieve the latest version of your repository.
`2`	`2`
`3`	`3`	`For more information about the components that this Quick Start deploys, see the link:#_architecture[Architecture] section later in this guide.`