edits part 6 122320

Author: censullo

docs/generated/parameters/git2s3.template.adoc

@@ -1,24 +1,33 @@
 
-.General Settings
+.General settings
 [width="100%",cols="16%,11%,73%",options="header",]
 |===
-|Parameter label (name) |Default value|Description|Output S3 Bucket Name
-(`OutputBucketName`)|`**__Blank string__**`|OPTIONAL: Bucket Name where the zip file output should be placed, if left blank a bucket name will be automatically generated.|Custom Domain Name
-(`CustomDomainName`)|`**__Blank string__**`|Use a custom domain name for the webhook endpoint, if left blank API Gateway will create a domain name for you
+|Parameter label (name) |Default value|Description|Output S3 bucket name
+(`OutputBucketName`)|`**__Blank string__**`|(Optional) Name for the S3 bucket where the Git repository .zip file is stored. If left blank, the Quick Start creates one for you.|Custom domain name
+(`CustomDomainName`)|`**__Blank string__**`|Domain name for the webhook endpoint. If left blank, API Gateway creates a domain name for you.
 |===
-.Git Pull Settings
+.Git pull settings
 [width="100%",cols="16%,11%,73%",options="header",]
 |===
-|Parameter label (name) |Default value|Description|API Secret
-(`ApiSecret`)|`**__Blank string__**`|gitpull method only. WebHook Secrets for use with GitHub Enterprise and GitLab. If a secret is matched IP range authentication is bypassed. Cannot contain: , \ "|Allowed IPs
-(`AllowedIps`)|`18.205.93.0/25,18.234.32.128/25,13.52.5.0/25`|gitpull method only. Comma seperated list of IP CIDR blocks for source IP authentication. The BitBucket Cloud IP ranges are provided as defaults.|Exclude Git
-(`ExcludeGit`)|`True`|Choose True to include the .git directory in the zip file or false to not include
+|Parameter label (name) |Default value|Description|API secret
+(`ApiSecret`)|`**__Blank string__**`|API secret used to authenticate access to webhooks in GitHub Enterprise, GitLab, and other Git services. If a webhook payload header contains a matching secret, IP address authentication is bypassed. API secrets cannot contain commas (,), backward slashes (\), or quotes (").|Allowed IP addresses
+(`AllowedIps`)|`18.205.93.0/25,18.234.32.128/25,13.52.5.0/25`|Comma-separated list of allowed IP CIDR blocks. The default addresses listed are BitBucket Cloud IP ranges.|Exclude .git directory
+(`ExcludeGit`)|`True`|Choose False to omit the .git directory from the Git repository .zip file.
 |===
-.AWS Quick Start Configuration
+.AWS Quick Start configuration
 [width="100%",cols="16%,11%,73%",options="header",]
 |===
-|Parameter label (name) |Default value|Description|Quick Start S3 Bucket Name
-(`QSS3BucketName`)|`aws-quickstart`|S3 bucket name for the Quick Start assets. Quick Start bucket name can include numbers, lowercase letters, uppercase letters, and hyphens (-). It cannot start or end with a hyphen (-).|Quick Start S3 bucket region
-(`QSS3BucketRegion`)|`us-east-1`|The AWS Region where the Quick Start S3 bucket (QSS3BucketName) is hosted. When using your own bucket, you must specify this value.|Quick Start S3 Key Prefix
-(`QSS3KeyPrefix`)|`quickstart-git2s3/`|S3 key prefix for the Quick Start assets. Quick Start key prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slash (/).
+|Parameter label (name) |Default value|Description|Quick Start S3 bucket name
+(`QSS3BucketName`)|`aws-quickstart`|S3 bucket name for Quick Start assets. It can include numbers, lowercase letters, uppercase letters, and hyphens (-). It cannot start or end with a hyphen (-).|Quick Start S3 bucket Region
+(`QSS3BucketRegion`)|`us-east-1`|AWS Region where the Quick Start assets S3 bucket (QSS3BucketName) is hosted. Required when using your own S3 bucket.|Quick Start S3 key prefix
+(`QSS3KeyPrefix`)|`quickstart-git2s3/`|Key prefix for the Quick Start assets S3 bucket. A key prefix is similar to a directory name that enables you to store similar data under the same directory in an S3 bucket. It can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/).
+|===
+.VPC configuration
+[width="100%",cols="16%,11%,73%",options="header",]
+|===
+|Parameter label (name) |Default value|Description|VPC ID
+(`VPCId`)|`**__Blank string__**`|ID of the VPC in which the Lambda function runs.|VPC CIDR
+(`VPCCidrRange`)|`**__Blank string__**`|CIDR range of the VPC.|Subnet IDs
+(`SubnetIds`)|`**__Blank string__**`|SubnetIDs in which the Lambda function runs.|Hostname override
+(`ScmHostnameOverride`)|`**__Blank string__**`|Name to override the hostname in the header of a webhook JSON payload.
 |===

docs/generated/parameters/index.adoc

@@ -1,3 +1,3 @@
 
-=== Deploying into your selected Region
+=== Parameters for deploying into your selected Region.
 include::git2s3.template.adoc[]

docs/partner_editable/additional_info.adoc

@@ -1,3 +1,32 @@
+=== Configuring Git services
+
+After deploying the Quick Start, set up a webhook in your Git repository. 
+
+To configure a webhook, you need *GitPullWebHookApi* and *PublicSSHKey*. You can find these on the *Outputs* tab on the AWS CloudFormation console after deploying the Quick Start.
+
+[#outputs_tab]
+.Outputs tab on the AWS CloudFormation console
+[link=images/outputs_tab.png]
+image::../images/outputs_tab.png[outputs_tab,width=701,height=222]
+
+* *GitPullWebHookApi* is the URL endpoint that receives the HTTP POST request from the Git service.
+* *PublicSSHKey* is the public SSH key used to connect to your Git repository. This key can be configured as a read-only machine user or as a deployment key in your Git repository.
+
+The instructions for setting up webhooks and deployment keys vary by Git service. For more information, see your Git service documentation.
+
+=== Configuring AWS services
+
+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:
+
+```
+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.
+
 == Adding an API secret after deployment
 
 You can launch this Quick Start without an *API Secret* parameter. If your Git service provides an API secret when you create a webhook, you can update the stack with the API secret later.  
@@ -40,4 +69,4 @@ We don’t recommend sharing SSH keys among multiple services, or launching anot
 
 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. 
 
-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 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.

docs/partner_editable/deploy_steps.adoc

@@ -14,41 +14,4 @@ NOTE: You are responsible for the cost of the AWS services used while running th
 [start=2]
 . Check the Region that’s displayed in the upper-right corner of the navigation bar, and change it if necessary. This Region is where the Quick Start infrastructure is built. The template for this Quick Start is launched in the US East (Ohio) Region by default.
 . On the *Select Template* page, keep the default setting for the template URL, and then choose *Next*.
-. On the *Specify Details* page, change the stack name if needed. Review the parameters for the template. Provide values for the parameters that require input. For all other parameters, review the default settings and customize them as necessary. After reviewing and customizing the parameters, choose *Next*.
-. On the *Options* page, you can https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html[specify tags] (key-value pairs) for resources in your stack and https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-add-tags.html[set advanced options]. When you’re done, choose *Next*.
-. On the *Review* page, review and confirm the template settings. Under *Capabilities*, select the check box to acknowledge that the template creates IAM resources.
-. Choose *Create* to deploy the stack. The stack takes approximately 15 minutes to create.
-. Monitor the status of the stack. When the status is *CREATE_COMPLETE*, the webhook resources are ready.
-. The *Outputs* tab for the stack contain the endpoint URL, the output S3 bucket name, and the public SSH key, as shown in <<outputs_tab>>.
-
-NOTE: You can also https://fwd.aws/wr8Gg[download the template] to use it as a starting point for your own implementation.
-
-=== Configuring Git services
-
-After deploying the Quick Start, set up a webhook in your Git repository. 
-
-To configure a webhook, you need *GitPullWebHookApi* and *PublicSSHKey*. You can find these on the *Outputs* tab on the AWS CloudFormation console after deploying the Quick Start.
-
-
-[#outputs_tab]
-.Outputs tab on the AWS CloudFormation console
-[link=images/outputs_tab.png]
-image::../images/outputs_tab.png[outputs_tab,width=701,height=222]
-
-* *GitPullWebHookApi* is the URL endpoint that receives the HTTP POST request from the Git service.
-* *PublicSSHKey* is the public SSH key used to connect to your Git repository. This key can be configured as a read-only machine user or as a deployment key in your Git repository.
-
-The instructions for setting up webhooks and deployment keys vary by Git service. For more information, see your Git service documentation.
-
-=== Configuring AWS services
-
-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:
-
-```
-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.
+. On the *Specify Details* page, change the stack name if needed. Review the parameters for the template. Provide values for the parameters that require input. For all other parameters, review the default settings and customize them as necessary. For details on each parameter, see the link:#_parameter_reference[Parameter reference] section of this guide. After reviewing and customizing the parameters, choose *Next*.

docs/partner_editable/faq_troubleshooting.adoc

@@ -14,7 +14,7 @@ For additional information, see https://docs.aws.amazon.com/AWSCloudFormation/la
 
 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 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 AWS CodeBuild project logs for errors. To access them, do the following:
 . Open the AWS CodeBuild console. 

docs/partner_editable/product_description.adoc

@@ -1,4 +1,4 @@
 
-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 endpoint is a URL the Quick Start creates that you use to link:#configuring_git_services[configure a Git webhook]. The HTTPS POST request contains JavaScript Object Notation (JSON) data about the push that invoked the webhook action. 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 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 endpoint is a URL the Quick Start creates that you use to link:#_configuring_git_services[configure a webhook]. The HTTPS POST request contains JavaScript Object Notation (JSON) data about the push that invoked the webhook action. 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. 
 
-For more information about the components that this Quick Start deploys, see the link:#architecture[Architecture] section later in this guide.
+For more information about the components that this Quick Start deploys, see the link:#_architecture[Architecture] section later in this guide.

templates/git2s3.template.yaml

@@ -107,7 +107,7 @@ Parameters:
     Type: String
     Default: ''
   ExcludeGit:
-    Description: Choose false to omit the .git directory from the Git repository .zip file.
+    Description: Choose False to omit the .git directory from the Git repository .zip file.
     Type: String
     Default: 'True'
     AllowedValues: ['True', 'False']