Merge pull request #940 from karensawrey/yml-update

Baking description and links to docs into the yaml template file

Author: keithduncan

templates/aws-stack.yml

@@ -2,6 +2,24 @@
 AWSTemplateFormatVersion: "2010-09-09"
 Description: "Buildkite stack %v"
 
+# The Buildkite Elastic CI Stack for AWS gives you a private,
+# autoscaling Buildkite Agent cluster. Use it to parallelize  
+# large test suites across thousands of nodes, run tests and 
+# deployments for Linux or Windows based services and apps,
+# or run AWS ops tasks.
+# 
+# To gain a better understanding of how Elastic CI Stack works 
+# and how to use it most effectively and securely, check out
+# the following resources: 
+#
+# * Elastic CI Stack for AWS Overview: https://buildkite.com/docs/agent/v3/elastic_ci_aws
+# * Elastic CI Stack for AWS Tutorial: https://buildkite.com/docs/tutorials/elastic-ci-stack-aws
+# * Running Buildkite Agent on AWS: https://buildkite.com/docs/agent/v3/aws
+# * GitHub Repo for Elastic CI Stack: https://github.com/buildkite/elastic-ci-stack-for-aws
+# * Using AWS Secrets Manager: https://buildkite.com/docs/agent/v3/aws/secrets-manager
+# * VPC Design: https://buildkite.com/docs/agent/v3/aws/vpc
+# * CloudFormation Service Role: https://buildkite.com/docs/agent/v3/elastic-ci-aws/cloudformation-service-role
+
 Transform: AWS::Serverless-2016-10-31
 
 Metadata: