From 0a7a29bf207d6744d2026d6fb9d68ab2bff1029f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=F0=9F=91=A8=F0=9F=8F=BC=E2=80=8D=F0=9F=92=BB=20Romain=20M?= =?UTF-8?q?arcadier-Muller?= Date: Tue, 31 Jul 2018 11:55:31 +0200 Subject: [PATCH 1/8] Add pkglint rule to require the presence of a README.md file And created the missing README.md files so that pkglint is happy. --- packages/@aws-cdk/applet-js/README.md | 2 + packages/@aws-cdk/aws-apigateway/README.md | 2 + .../aws-applicationautoscaling/README.md | 2 + packages/@aws-cdk/aws-appsync/README.md | 2 + packages/@aws-cdk/aws-athena/README.md | 2 + packages/@aws-cdk/aws-autoscaling/README.md | 2 + .../@aws-cdk/aws-autoscalingplans/README.md | 2 + packages/@aws-cdk/aws-batch/README.md | 2 + packages/@aws-cdk/aws-budgets/README.md | 2 + packages/@aws-cdk/aws-cloud9/README.md | 2 + .../@aws-cdk/aws-cloudformation/README.md | 2 + packages/@aws-cdk/aws-codedeploy/README.md | 2 + packages/@aws-cdk/aws-cognito/README.md | 2 + packages/@aws-cdk/aws-config/README.md | 2 + packages/@aws-cdk/aws-datapipeline/README.md | 2 + packages/@aws-cdk/aws-dax/README.md | 2 + .../@aws-cdk/aws-directoryservice/README.md | 2 + packages/@aws-cdk/aws-dms/README.md | 2 + packages/@aws-cdk/aws-ecr/README.md | 2 + packages/@aws-cdk/aws-ecs/README.md | 2 + packages/@aws-cdk/aws-efs/README.md | 2 + packages/@aws-cdk/aws-eks/README.md | 2 + packages/@aws-cdk/aws-elasticache/README.md | 2 + .../@aws-cdk/aws-elasticbeanstalk/README.md | 2 + .../aws-elasticloadbalancing/README.md | 2 + .../aws-elasticloadbalancingv2/README.md | 2 + packages/@aws-cdk/aws-elasticsearch/README.md | 2 + packages/@aws-cdk/aws-emr/README.md | 2 + packages/@aws-cdk/aws-gamelift/README.md | 2 + packages/@aws-cdk/aws-glue/README.md | 2 + packages/@aws-cdk/aws-guardduty/README.md | 2 + packages/@aws-cdk/aws-inspector/README.md | 2 + packages/@aws-cdk/aws-iot/README.md | 2 + .../@aws-cdk/aws-kinesisanalytics/README.md | 2 + .../@aws-cdk/aws-kinesisfirehose/README.md | 2 + packages/@aws-cdk/aws-neptune/README.md | 2 + packages/@aws-cdk/aws-opsworks/README.md | 2 + packages/@aws-cdk/aws-quickstarts/README.md | 2 + packages/@aws-cdk/aws-redshift/README.md | 2 + packages/@aws-cdk/aws-sdb/README.md | 2 + packages/@aws-cdk/aws-serverless/README.md | 2 + .../@aws-cdk/aws-servicecatalog/README.md | 2 + .../@aws-cdk/aws-servicediscovery/README.md | 2 + packages/@aws-cdk/aws-ses/README.md | 2 + packages/@aws-cdk/aws-ssm/README.md | 2 + packages/@aws-cdk/aws-stepfunctions/README.md | 2 + packages/@aws-cdk/aws-waf/README.md | 2 + packages/@aws-cdk/aws-wafregional/README.md | 2 + packages/@aws-cdk/aws-workspaces/README.md | 2 + packages/@aws-cdk/cdk/README.md | 2 + .../@aws-cdk/cloudformation-diff/README.md | 2 + packages/@aws-cdk/cx-api/README.md | 2 + packages/@aws-cdk/util/README.md | 2 + packages/aws-cdk/README.md | 162 ++++++++++++++++++ tools/pkglint/lib/rules.ts | 36 ++-- tools/pkgtools/README.md | 2 + 56 files changed, 288 insertions(+), 18 deletions(-) create mode 100644 packages/@aws-cdk/applet-js/README.md create mode 100644 packages/@aws-cdk/aws-apigateway/README.md create mode 100644 packages/@aws-cdk/aws-applicationautoscaling/README.md create mode 100644 packages/@aws-cdk/aws-appsync/README.md create mode 100644 packages/@aws-cdk/aws-athena/README.md create mode 100644 packages/@aws-cdk/aws-autoscaling/README.md create mode 100644 packages/@aws-cdk/aws-autoscalingplans/README.md create mode 100644 packages/@aws-cdk/aws-batch/README.md create mode 100644 packages/@aws-cdk/aws-budgets/README.md create mode 100644 packages/@aws-cdk/aws-cloud9/README.md create mode 100644 packages/@aws-cdk/aws-cloudformation/README.md create mode 100644 packages/@aws-cdk/aws-codedeploy/README.md create mode 100644 packages/@aws-cdk/aws-cognito/README.md create mode 100644 packages/@aws-cdk/aws-config/README.md create mode 100644 packages/@aws-cdk/aws-datapipeline/README.md create mode 100644 packages/@aws-cdk/aws-dax/README.md create mode 100644 packages/@aws-cdk/aws-directoryservice/README.md create mode 100644 packages/@aws-cdk/aws-dms/README.md create mode 100644 packages/@aws-cdk/aws-ecr/README.md create mode 100644 packages/@aws-cdk/aws-ecs/README.md create mode 100644 packages/@aws-cdk/aws-efs/README.md create mode 100644 packages/@aws-cdk/aws-eks/README.md create mode 100644 packages/@aws-cdk/aws-elasticache/README.md create mode 100644 packages/@aws-cdk/aws-elasticbeanstalk/README.md create mode 100644 packages/@aws-cdk/aws-elasticloadbalancing/README.md create mode 100644 packages/@aws-cdk/aws-elasticloadbalancingv2/README.md create mode 100644 packages/@aws-cdk/aws-elasticsearch/README.md create mode 100644 packages/@aws-cdk/aws-emr/README.md create mode 100644 packages/@aws-cdk/aws-gamelift/README.md create mode 100644 packages/@aws-cdk/aws-glue/README.md create mode 100644 packages/@aws-cdk/aws-guardduty/README.md create mode 100644 packages/@aws-cdk/aws-inspector/README.md create mode 100644 packages/@aws-cdk/aws-iot/README.md create mode 100644 packages/@aws-cdk/aws-kinesisanalytics/README.md create mode 100644 packages/@aws-cdk/aws-kinesisfirehose/README.md create mode 100644 packages/@aws-cdk/aws-neptune/README.md create mode 100644 packages/@aws-cdk/aws-opsworks/README.md create mode 100644 packages/@aws-cdk/aws-quickstarts/README.md create mode 100644 packages/@aws-cdk/aws-redshift/README.md create mode 100644 packages/@aws-cdk/aws-sdb/README.md create mode 100644 packages/@aws-cdk/aws-serverless/README.md create mode 100644 packages/@aws-cdk/aws-servicecatalog/README.md create mode 100644 packages/@aws-cdk/aws-servicediscovery/README.md create mode 100644 packages/@aws-cdk/aws-ses/README.md create mode 100644 packages/@aws-cdk/aws-ssm/README.md create mode 100644 packages/@aws-cdk/aws-stepfunctions/README.md create mode 100644 packages/@aws-cdk/aws-waf/README.md create mode 100644 packages/@aws-cdk/aws-wafregional/README.md create mode 100644 packages/@aws-cdk/aws-workspaces/README.md create mode 100644 packages/@aws-cdk/cdk/README.md create mode 100644 packages/@aws-cdk/cloudformation-diff/README.md create mode 100644 packages/@aws-cdk/cx-api/README.md create mode 100644 packages/@aws-cdk/util/README.md create mode 100644 packages/aws-cdk/README.md create mode 100644 tools/pkgtools/README.md diff --git a/packages/@aws-cdk/applet-js/README.md b/packages/@aws-cdk/applet-js/README.md new file mode 100644 index 0000000000000..d583b3dbc1f08 --- /dev/null +++ b/packages/@aws-cdk/applet-js/README.md @@ -0,0 +1,2 @@ +## AWS CDK applet host program for Javascript +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-apigateway/README.md b/packages/@aws-cdk/aws-apigateway/README.md new file mode 100644 index 0000000000000..488e67b16c110 --- /dev/null +++ b/packages/@aws-cdk/aws-apigateway/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS API Gateway +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-applicationautoscaling/README.md b/packages/@aws-cdk/aws-applicationautoscaling/README.md new file mode 100644 index 0000000000000..be8773df23e0f --- /dev/null +++ b/packages/@aws-cdk/aws-applicationautoscaling/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Application Auto-Scaling +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-appsync/README.md b/packages/@aws-cdk/aws-appsync/README.md new file mode 100644 index 0000000000000..86b2b5b978371 --- /dev/null +++ b/packages/@aws-cdk/aws-appsync/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS AppSync +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-athena/README.md b/packages/@aws-cdk/aws-athena/README.md new file mode 100644 index 0000000000000..64895511ec934 --- /dev/null +++ b/packages/@aws-cdk/aws-athena/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Athena +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-autoscaling/README.md b/packages/@aws-cdk/aws-autoscaling/README.md new file mode 100644 index 0000000000000..0846a7231d7c0 --- /dev/null +++ b/packages/@aws-cdk/aws-autoscaling/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Auto-Scaling +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-autoscalingplans/README.md b/packages/@aws-cdk/aws-autoscalingplans/README.md new file mode 100644 index 0000000000000..4087e2df56ad1 --- /dev/null +++ b/packages/@aws-cdk/aws-autoscalingplans/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Auto-Scaling Plans +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-batch/README.md b/packages/@aws-cdk/aws-batch/README.md new file mode 100644 index 0000000000000..c5ac80e8591b5 --- /dev/null +++ b/packages/@aws-cdk/aws-batch/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Batch +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-budgets/README.md b/packages/@aws-cdk/aws-budgets/README.md new file mode 100644 index 0000000000000..0ceef7e8ead30 --- /dev/null +++ b/packages/@aws-cdk/aws-budgets/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Budgets +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-cloud9/README.md b/packages/@aws-cdk/aws-cloud9/README.md new file mode 100644 index 0000000000000..18417aefd38c0 --- /dev/null +++ b/packages/@aws-cdk/aws-cloud9/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Cloud9 +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-cloudformation/README.md b/packages/@aws-cdk/aws-cloudformation/README.md new file mode 100644 index 0000000000000..1878a00b082a8 --- /dev/null +++ b/packages/@aws-cdk/aws-cloudformation/README.md @@ -0,0 +1,2 @@ +## CDK Constructs for AWS CloudFormation +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. \ No newline at end of file diff --git a/packages/@aws-cdk/aws-codedeploy/README.md b/packages/@aws-cdk/aws-codedeploy/README.md new file mode 100644 index 0000000000000..08ac5d9c7e66c --- /dev/null +++ b/packages/@aws-cdk/aws-codedeploy/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS CodeDeploy +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-cognito/README.md b/packages/@aws-cdk/aws-cognito/README.md new file mode 100644 index 0000000000000..71a7a1920f016 --- /dev/null +++ b/packages/@aws-cdk/aws-cognito/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Cognito +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-config/README.md b/packages/@aws-cdk/aws-config/README.md new file mode 100644 index 0000000000000..57d24dbfd9e16 --- /dev/null +++ b/packages/@aws-cdk/aws-config/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Config +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-datapipeline/README.md b/packages/@aws-cdk/aws-datapipeline/README.md new file mode 100644 index 0000000000000..491c3903b78a6 --- /dev/null +++ b/packages/@aws-cdk/aws-datapipeline/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Data Pipeline +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-dax/README.md b/packages/@aws-cdk/aws-dax/README.md new file mode 100644 index 0000000000000..3e004cfd35744 --- /dev/null +++ b/packages/@aws-cdk/aws-dax/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Data Accelerator (DAX) +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-directoryservice/README.md b/packages/@aws-cdk/aws-directoryservice/README.md new file mode 100644 index 0000000000000..b931f368842a8 --- /dev/null +++ b/packages/@aws-cdk/aws-directoryservice/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Directory Service +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-dms/README.md b/packages/@aws-cdk/aws-dms/README.md new file mode 100644 index 0000000000000..8f1bd8e08b2d3 --- /dev/null +++ b/packages/@aws-cdk/aws-dms/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Database Migration Service (DMS) +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-ecr/README.md b/packages/@aws-cdk/aws-ecr/README.md new file mode 100644 index 0000000000000..7629882651d98 --- /dev/null +++ b/packages/@aws-cdk/aws-ecr/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Elastic Container Registry (ECR) +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-ecs/README.md b/packages/@aws-cdk/aws-ecs/README.md new file mode 100644 index 0000000000000..0b281e1184740 --- /dev/null +++ b/packages/@aws-cdk/aws-ecs/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Elastic Container Service (ECS) +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-efs/README.md b/packages/@aws-cdk/aws-efs/README.md new file mode 100644 index 0000000000000..c65062999a472 --- /dev/null +++ b/packages/@aws-cdk/aws-efs/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Elastic File System (EFS) +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md new file mode 100644 index 0000000000000..6bf0898a242df --- /dev/null +++ b/packages/@aws-cdk/aws-eks/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS EKS +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-elasticache/README.md b/packages/@aws-cdk/aws-elasticache/README.md new file mode 100644 index 0000000000000..fde7bff6ef936 --- /dev/null +++ b/packages/@aws-cdk/aws-elasticache/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS ElastiCache +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-elasticbeanstalk/README.md b/packages/@aws-cdk/aws-elasticbeanstalk/README.md new file mode 100644 index 0000000000000..d45bac41b95e3 --- /dev/null +++ b/packages/@aws-cdk/aws-elasticbeanstalk/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Elastic Beanstalk +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-elasticloadbalancing/README.md b/packages/@aws-cdk/aws-elasticloadbalancing/README.md new file mode 100644 index 0000000000000..45244f2937771 --- /dev/null +++ b/packages/@aws-cdk/aws-elasticloadbalancing/README.md @@ -0,0 +1,2 @@ +## CDK Constructs for AWS Elastic Load Balancing (ELB) +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/README.md b/packages/@aws-cdk/aws-elasticloadbalancingv2/README.md new file mode 100644 index 0000000000000..236ac2628a36c --- /dev/null +++ b/packages/@aws-cdk/aws-elasticloadbalancingv2/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Elastic Load Balancing (V2) +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-elasticsearch/README.md b/packages/@aws-cdk/aws-elasticsearch/README.md new file mode 100644 index 0000000000000..914b852b33a63 --- /dev/null +++ b/packages/@aws-cdk/aws-elasticsearch/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Elasticsearch +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-emr/README.md b/packages/@aws-cdk/aws-emr/README.md new file mode 100644 index 0000000000000..79584f37a6394 --- /dev/null +++ b/packages/@aws-cdk/aws-emr/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Elastic MapReduce (EMR) +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-gamelift/README.md b/packages/@aws-cdk/aws-gamelift/README.md new file mode 100644 index 0000000000000..a10c55036fba4 --- /dev/null +++ b/packages/@aws-cdk/aws-gamelift/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS GameLift +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-glue/README.md b/packages/@aws-cdk/aws-glue/README.md new file mode 100644 index 0000000000000..ebd297dde485c --- /dev/null +++ b/packages/@aws-cdk/aws-glue/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Glue +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-guardduty/README.md b/packages/@aws-cdk/aws-guardduty/README.md new file mode 100644 index 0000000000000..fe1a098c31a73 --- /dev/null +++ b/packages/@aws-cdk/aws-guardduty/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS GuardDuty +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-inspector/README.md b/packages/@aws-cdk/aws-inspector/README.md new file mode 100644 index 0000000000000..3346717265b2e --- /dev/null +++ b/packages/@aws-cdk/aws-inspector/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Inspector +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-iot/README.md b/packages/@aws-cdk/aws-iot/README.md new file mode 100644 index 0000000000000..4977e4986a6f7 --- /dev/null +++ b/packages/@aws-cdk/aws-iot/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS IoT +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-kinesisanalytics/README.md b/packages/@aws-cdk/aws-kinesisanalytics/README.md new file mode 100644 index 0000000000000..5c0ac713bb678 --- /dev/null +++ b/packages/@aws-cdk/aws-kinesisanalytics/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Kinesis Analytics +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-kinesisfirehose/README.md b/packages/@aws-cdk/aws-kinesisfirehose/README.md new file mode 100644 index 0000000000000..76e4ea94891e6 --- /dev/null +++ b/packages/@aws-cdk/aws-kinesisfirehose/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Kinesis Firehose +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-neptune/README.md b/packages/@aws-cdk/aws-neptune/README.md new file mode 100644 index 0000000000000..b321993491ebe --- /dev/null +++ b/packages/@aws-cdk/aws-neptune/README.md @@ -0,0 +1,2 @@ +## CDK Constructs for AWS Neptune +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. \ No newline at end of file diff --git a/packages/@aws-cdk/aws-opsworks/README.md b/packages/@aws-cdk/aws-opsworks/README.md new file mode 100644 index 0000000000000..32533de3b3f19 --- /dev/null +++ b/packages/@aws-cdk/aws-opsworks/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS OpsWorks +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-quickstarts/README.md b/packages/@aws-cdk/aws-quickstarts/README.md new file mode 100644 index 0000000000000..a4c76aeba0064 --- /dev/null +++ b/packages/@aws-cdk/aws-quickstarts/README.md @@ -0,0 +1,2 @@ +## AWS Quickstarts for the CDK +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. \ No newline at end of file diff --git a/packages/@aws-cdk/aws-redshift/README.md b/packages/@aws-cdk/aws-redshift/README.md new file mode 100644 index 0000000000000..8cda8683b3938 --- /dev/null +++ b/packages/@aws-cdk/aws-redshift/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Redshift +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-sdb/README.md b/packages/@aws-cdk/aws-sdb/README.md new file mode 100644 index 0000000000000..aabac68e3b5a1 --- /dev/null +++ b/packages/@aws-cdk/aws-sdb/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Simple Database +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-serverless/README.md b/packages/@aws-cdk/aws-serverless/README.md new file mode 100644 index 0000000000000..51404dfe12fd6 --- /dev/null +++ b/packages/@aws-cdk/aws-serverless/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for the AWS Serverless Application Model (SAM) +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-servicecatalog/README.md b/packages/@aws-cdk/aws-servicecatalog/README.md new file mode 100644 index 0000000000000..8d6ead96bf398 --- /dev/null +++ b/packages/@aws-cdk/aws-servicecatalog/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Service Catalog +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-servicediscovery/README.md b/packages/@aws-cdk/aws-servicediscovery/README.md new file mode 100644 index 0000000000000..82818175c1dc5 --- /dev/null +++ b/packages/@aws-cdk/aws-servicediscovery/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Service Discovery +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-ses/README.md b/packages/@aws-cdk/aws-ses/README.md new file mode 100644 index 0000000000000..77cf9101c97ba --- /dev/null +++ b/packages/@aws-cdk/aws-ses/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Simple Email Service +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-ssm/README.md b/packages/@aws-cdk/aws-ssm/README.md new file mode 100644 index 0000000000000..393827933993f --- /dev/null +++ b/packages/@aws-cdk/aws-ssm/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Systems Manager +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-stepfunctions/README.md b/packages/@aws-cdk/aws-stepfunctions/README.md new file mode 100644 index 0000000000000..30aed40788ef4 --- /dev/null +++ b/packages/@aws-cdk/aws-stepfunctions/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Step Functions +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-waf/README.md b/packages/@aws-cdk/aws-waf/README.md new file mode 100644 index 0000000000000..ef6b649daefc6 --- /dev/null +++ b/packages/@aws-cdk/aws-waf/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Web Application Firewall +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-wafregional/README.md b/packages/@aws-cdk/aws-wafregional/README.md new file mode 100644 index 0000000000000..42bbfb57a8bd1 --- /dev/null +++ b/packages/@aws-cdk/aws-wafregional/README.md @@ -0,0 +1,2 @@ +## The CDK Construct Library for AWS Web Application Firewall (Regional) +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-workspaces/README.md b/packages/@aws-cdk/aws-workspaces/README.md new file mode 100644 index 0000000000000..e706bfb9d367d --- /dev/null +++ b/packages/@aws-cdk/aws-workspaces/README.md @@ -0,0 +1,2 @@ +## AWS CDK Construct Library for AWS WorkSpaces +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/cdk/README.md b/packages/@aws-cdk/cdk/README.md new file mode 100644 index 0000000000000..8460ea17805c0 --- /dev/null +++ b/packages/@aws-cdk/cdk/README.md @@ -0,0 +1,2 @@ +## AWS Cloud Development Kit for Javascript +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. \ No newline at end of file diff --git a/packages/@aws-cdk/cloudformation-diff/README.md b/packages/@aws-cdk/cloudformation-diff/README.md new file mode 100644 index 0000000000000..e4bf4e04cfac9 --- /dev/null +++ b/packages/@aws-cdk/cloudformation-diff/README.md @@ -0,0 +1,2 @@ +## Utilities to diff AWS CDK stacks against CloudFormation templates +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/cx-api/README.md b/packages/@aws-cdk/cx-api/README.md new file mode 100644 index 0000000000000..828bd9ea1a1ce --- /dev/null +++ b/packages/@aws-cdk/cx-api/README.md @@ -0,0 +1,2 @@ +## Cloud Executable protocol +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/util/README.md b/packages/@aws-cdk/util/README.md new file mode 100644 index 0000000000000..938d8de0f8789 --- /dev/null +++ b/packages/@aws-cdk/util/README.md @@ -0,0 +1,2 @@ +## Utility routines used for implementing AWS CDK libraries +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/aws-cdk/README.md b/packages/aws-cdk/README.md new file mode 100644 index 0000000000000..880f73e8b4a5f --- /dev/null +++ b/packages/aws-cdk/README.md @@ -0,0 +1,162 @@ +## AWS CDK Toolkit +The AWS CDK Toolkit provides the `cdk` command-line interface that can be used to work with AWS CDK applications. + +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. + +### Commands +#### `cdk docs` +Outputs the URL to the documentation for the current toolkit version, and attempts to open a browser to that URL. + +```shell +# Open the documentation in the default browser (using 'open') +$ cdk docs +https://awslabs.github.io/aws-cdk/versions/0.7.4-beta/ + +# Open the documentation in Chrome. +$ cdk docs --browser='chrome %u' +https://awslabs.github.io/aws-cdk/versions/0.7.4-beta/ +``` + +#### `cdk init` +Creates a new CDK project. + +```shell +# List the available template types & languages +$ cdk init --list +Available templates: +* app: Template for a CDK Application + └─ cdk init app --language=[java|typescript] +* lib: Template for a CDK Construct Library + └─ cdk init lib --language=typescript + +# Create a new library application in typescript +$ cdk init lib --language=typescript +``` + +#### `cdk bootstrap` +Deploys a `CDKToolkit` CloudFormation stack into the specified environment(s), that provides an S3 bucket that +`cdk deploy` will use to store synthesized templates and the related assets, before triggering a CloudFormation stack +update. The name of the deployed stack can be configured using the `--toolkit-stack-name` argument. + +```shell +# Deploys to all environments +$ cdk bootstrap --app='node bin/main.js' + +# Deploys only to environments foo and bar +$ cdk bootstrap --app='node bin/main.js' foo bar +``` + +#### `cdk list` +Lists the stacks modeled in the CDK application. + +```shell +# List all stacks in the CDK app 'node bin/main.js' +$ cdk list --app='node bin/main.js' +Foo +Bar +Baz + +# List all stack including all details (add --json to output JSON instead of YAML) +$ cdk list --app='node bin/main.js' --long +- + name: Foo + environment: + name: 000000000000/bermuda-triangle-1 + account: '000000000000' + region: bermuda-triangle-1 +- + name: Bar + environment: + name: 111111111111/bermuda-triangle-2 + account: '111111111111' + region: bermuda-triangle-2 +- + name: Baz + environment: + name: 333333333333/bermuda-triangle-3 + account: '333333333333' + region: bermuda-triangle-3 +``` + +#### `cdk synthesize` +Synthesize the CDK Application and outputs CloudFormation templates. If the application contains multiple stacks and no +stack name is provided in the command-line arguments, the `--output` option is mandatory and a CloudFormation template +will be generated in the output folder for each stack. + +By default, templates are generated in YAML format. The `--json` option can be used to switch to JSON. + +```shell +# Generate the template for StackName and output it to STDOUT +$ cdk synthesize --app='node bin/main.js' StackName + +# Generate the template for StackName and save it to template.yml +$ cdk synthesize --app='node bin/main.js' StackName --output=template.yml + +# Generate templates for all the stacks and save them into templates/ +$ cdk synthesize --app='node bin/main.js' --output=templates +``` + +#### `cdk deploy` +Deploys a stack of your CDK application to it's environment. During the deployment, the toolkit will output progress +indications, similar to what can be observed in the AWS CloudFormation Console. If the environment was never +bootstrapped (using `cdk bootstrap`), only stacks that are not using assets and synthesize to a template that is under +51,200 bytes will successfully deploy. + +```shell +$ cdk deploy --app='node bin/main.js' StackName +``` + +#### `cdk diff` +Computes differences between the infrastructure specified in the current state of the CDK Application and the currently +deployed application (or a user-specified CloudFomration template). This command returns non-`0` if any differences are +found. + +```shell +# Diff against the currently deployed stack +$ cdk diff --app='node bin/main.js' StackName + +# Diff against a specific template document +$ cdk diff --app='node bin/main.js' StackName --template=path/to/template.yml +``` + +#### `cdk destroy` +Deletes a stack from it's environment. This will cause the resources in the stack to be destroyed (unless they were +configured with a `DeletionPolicy` of `Retain`). During the stack destruction, the command will output progress +information similar to what `cdk deploy` provides. + +```shell +$ cdk destroy --app='node bin/main.js' StackName +``` + +#### `cdk doctor` +Inspect the current command-line environment and configurations, and collect information that can be useful for +troubleshooting problems. It is usually a good idea to include the information provided by this command when submitting +a bug report. + +```shell +$ cdk doctor +ℹ️ CDK Version: 0.7.4-beta (build 0191444) +ℹ️ AWS environment variables: + - AWS_EC2_METADATA_DISABLED = 1 + - AWS_SDK_LOAD_CONFIG = 1 +``` + +### Configuration +On top of passing configuration through command-line arguments, it is possible to use JSON configuration files. The +configuration's order of precedence is: +1. Command-line arguments +2. Project configuration (`./cdk.json`) +3. User configuration (`~/.cdk.json`) + +#### JSON Configuration files +Some of the interesting keys that can be used in the JSON configuration files: +```json +{ + "app": "node bin/main.js", // Command to start the CDK Application (--app='node bin/main.js') + "context": { // Context entries (--context=key:value) + "key": "value", + }, + "toolkitStackName": "foo", // Customize 'bootstrap' stack name (--toolkit-stack-name=foo) + "versionReporting": false, // Opt-out of version reporting (--no-version-reporting) +} +``` diff --git a/tools/pkglint/lib/rules.ts b/tools/pkglint/lib/rules.ts index 3249555850484..09098c4fd9768 100644 --- a/tools/pkglint/lib/rules.ts +++ b/tools/pkglint/lib/rules.ts @@ -77,6 +77,24 @@ export class AuthorAWS extends ValidationRule { } } +/** + * There must be a README.md file. + */ +export class ReadmeFile extends ValidationRule { + public validate(pkg: PackageJson): void { + const readmeFile = path.join(pkg.packageRoot, 'README.md'); + if (!fs.existsSync(readmeFile)) { + pkg.report({ + message: 'There must be a README.md file at the root of the package', + fix: () => fs.writeFileSync( + readmeFile, + `## ${pkg.json.description}\nThis module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project.` + ) + }); + } + } +} + /** * Keywords must contain CDK keywords and be sorted */ @@ -107,24 +125,6 @@ export class CDKKeywords extends ValidationRule { } } -/** - * Package.json must have 'jsii' section if and only if it's a JSII package - */ -export class JSIISectionPresent extends ValidationRule { - public validate(pkg: PackageJson): void { - const hasJSIISection = 'jsii' in pkg.json; - if (isJSII(pkg)) { - if (!hasJSIISection) { - pkg.report({ message: 'JSII package must have "jsii" section in package.json' }); - } - } else { - if (hasJSIISection) { - pkg.report({ message: 'Non-JSII package must not have "jsii" section in package.json' }); - } - } - } -} - /** * JSII Java package is required and must look sane */ diff --git a/tools/pkgtools/README.md b/tools/pkgtools/README.md new file mode 100644 index 0000000000000..71ce8ab5237bd --- /dev/null +++ b/tools/pkgtools/README.md @@ -0,0 +1,2 @@ +## Tools for generating cross-package artifacts +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. \ No newline at end of file From 8e2be0e5236f3a051cc5555c2793d90155620387 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=F0=9F=91=A8=F0=9F=8F=BC=E2=80=8D=F0=9F=92=BB=20Romain=20M?= =?UTF-8?q?arcadier-Muller?= Date: Tue, 31 Jul 2018 13:11:41 +0200 Subject: [PATCH 2/8] Some twaks to aws-cdk/README.md --- packages/aws-cdk/README.md | 80 ++++++++++++++++++++------------------ 1 file changed, 42 insertions(+), 38 deletions(-) diff --git a/packages/aws-cdk/README.md b/packages/aws-cdk/README.md index 880f73e8b4a5f..291de7eec4b98 100644 --- a/packages/aws-cdk/README.md +++ b/packages/aws-cdk/README.md @@ -4,6 +4,10 @@ The AWS CDK Toolkit provides the `cdk` command-line interface that can be used t This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. ### Commands +The `cdk` tool provides commands to manage the whole lifecycle of your CDK app: [creating](#cdk-init) a new project, +[listing](#cdk-list) the stacks in an app, [synthesizing](#cdk-synth) the CloudFormation templates, [diffing](#cdk-diff) +against your currently deployed infrastructure, [deploying](#cdk-deploy) into AWS accounts, and more. + #### `cdk docs` Outputs the URL to the documentation for the current toolkit version, and attempts to open a browser to that URL. @@ -33,21 +37,8 @@ Available templates: $ cdk init lib --language=typescript ``` -#### `cdk bootstrap` -Deploys a `CDKToolkit` CloudFormation stack into the specified environment(s), that provides an S3 bucket that -`cdk deploy` will use to store synthesized templates and the related assets, before triggering a CloudFormation stack -update. The name of the deployed stack can be configured using the `--toolkit-stack-name` argument. - -```shell -# Deploys to all environments -$ cdk bootstrap --app='node bin/main.js' - -# Deploys only to environments foo and bar -$ cdk bootstrap --app='node bin/main.js' foo bar -``` - #### `cdk list` -Lists the stacks modeled in the CDK application. +Lists the stacks modeled in the CDK app. ```shell # List all stacks in the CDK app 'node bin/main.js' @@ -79,7 +70,7 @@ $ cdk list --app='node bin/main.js' --long ``` #### `cdk synthesize` -Synthesize the CDK Application and outputs CloudFormation templates. If the application contains multiple stacks and no +Synthesize the CDK app and outputs CloudFormation templates. If the application contains multiple stacks and no stack name is provided in the command-line arguments, the `--output` option is mandatory and a CloudFormation template will be generated in the output folder for each stack. @@ -87,36 +78,36 @@ By default, templates are generated in YAML format. The `--json` option can be u ```shell # Generate the template for StackName and output it to STDOUT -$ cdk synthesize --app='node bin/main.js' StackName +$ cdk synthesize --app='node bin/main.js' MyStackName -# Generate the template for StackName and save it to template.yml -$ cdk synthesize --app='node bin/main.js' StackName --output=template.yml +# Generate the template for MyStackName and save it to template.yml +$ cdk synth --app='node bin/main.js' MyStackName --output=template.yml # Generate templates for all the stacks and save them into templates/ -$ cdk synthesize --app='node bin/main.js' --output=templates -``` - -#### `cdk deploy` -Deploys a stack of your CDK application to it's environment. During the deployment, the toolkit will output progress -indications, similar to what can be observed in the AWS CloudFormation Console. If the environment was never -bootstrapped (using `cdk bootstrap`), only stacks that are not using assets and synthesize to a template that is under -51,200 bytes will successfully deploy. - -```shell -$ cdk deploy --app='node bin/main.js' StackName +$ cdk synth --app='node bin/main.js' --output=templates ``` #### `cdk diff` -Computes differences between the infrastructure specified in the current state of the CDK Application and the currently -deployed application (or a user-specified CloudFomration template). This command returns non-`0` if any differences are +Computes differences between the infrastructure specified in the current state of the CDK app and the currently +deployed application (or a user-specified CloudFormation template). This command returns non-zero if any differences are found. ```shell # Diff against the currently deployed stack -$ cdk diff --app='node bin/main.js' StackName +$ cdk diff --app='node bin/main.js' MyStackName # Diff against a specific template document -$ cdk diff --app='node bin/main.js' StackName --template=path/to/template.yml +$ cdk diff --app='node bin/main.js' MyStackName --template=path/to/template.yml +``` + +#### `cdk deploy` +Deploys a stack of your CDK app to it's environment. During the deployment, the toolkit will output progress +indications, similar to what can be observed in the AWS CloudFormation Console. If the environment was never +bootstrapped (using `cdk bootstrap`), only stacks that are not using assets and synthesize to a template that is under +51,200 bytes will successfully deploy. + +```shell +$ cdk deploy --app='node bin/main.js' MyStackName ``` #### `cdk destroy` @@ -125,7 +116,20 @@ configured with a `DeletionPolicy` of `Retain`). During the stack destruction, t information similar to what `cdk deploy` provides. ```shell -$ cdk destroy --app='node bin/main.js' StackName +$ cdk destroy --app='node bin/main.js' MyStackName +``` + +#### `cdk bootstrap` +Deploys a `CDKToolkit` CloudFormation stack into the specified environment(s), that provides an S3 bucket that +`cdk deploy` will use to store synthesized templates and the related assets, before triggering a CloudFormation stack +update. The name of the deployed stack can be configured using the `--toolkit-stack-name` argument. + +```shell +# Deploys to all environments +$ cdk bootstrap --app='node bin/main.js' + +# Deploys only to environments foo and bar +$ cdk bootstrap --app='node bin/main.js' foo bar ``` #### `cdk doctor` @@ -152,11 +156,11 @@ configuration's order of precedence is: Some of the interesting keys that can be used in the JSON configuration files: ```json { - "app": "node bin/main.js", // Command to start the CDK Application (--app='node bin/main.js') - "context": { // Context entries (--context=key:value) + "app": "node bin/main.js", // Command to start the CDK app (--app='node bin/main.js') + "context": { // Context entries (--context=key:value) "key": "value", }, - "toolkitStackName": "foo", // Customize 'bootstrap' stack name (--toolkit-stack-name=foo) - "versionReporting": false, // Opt-out of version reporting (--no-version-reporting) + "toolkitStackName": "foo", // Customize 'bootstrap' stack name (--toolkit-stack-name=foo) + "versionReporting": false, // Opt-out of version reporting (--no-version-reporting) } ``` From 8283e9705d0447cb5111edebad08b410f160bb4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=F0=9F=91=A8=F0=9F=8F=BC=E2=80=8D=F0=9F=92=BB=20Romain=20M?= =?UTF-8?q?arcadier-Muller?= Date: Tue, 31 Jul 2018 13:14:18 +0200 Subject: [PATCH 3/8] Switch JSON block to use JS highlighter, so comments are handled properly. --- packages/aws-cdk/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/aws-cdk/README.md b/packages/aws-cdk/README.md index 291de7eec4b98..5d228437d7c27 100644 --- a/packages/aws-cdk/README.md +++ b/packages/aws-cdk/README.md @@ -154,7 +154,7 @@ configuration's order of precedence is: #### JSON Configuration files Some of the interesting keys that can be used in the JSON configuration files: -```json +```js { "app": "node bin/main.js", // Command to start the CDK app (--app='node bin/main.js') "context": { // Context entries (--context=key:value) From feba50c5adad24b52851cfde56669649528ff013 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=F0=9F=91=A8=F0=9F=8F=BC=E2=80=8D=F0=9F=92=BB=20Romain=20M?= =?UTF-8?q?arcadier-Muller?= Date: Tue, 31 Jul 2018 13:16:07 +0200 Subject: [PATCH 4/8] Switch shell examples to 'console' formatter --- packages/aws-cdk/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/aws-cdk/README.md b/packages/aws-cdk/README.md index 5d228437d7c27..ff75f4867be1a 100644 --- a/packages/aws-cdk/README.md +++ b/packages/aws-cdk/README.md @@ -11,7 +11,7 @@ against your currently deployed infrastructure, [deploying](#cdk-deploy) into AW #### `cdk docs` Outputs the URL to the documentation for the current toolkit version, and attempts to open a browser to that URL. -```shell +```console # Open the documentation in the default browser (using 'open') $ cdk docs https://awslabs.github.io/aws-cdk/versions/0.7.4-beta/ @@ -24,7 +24,7 @@ https://awslabs.github.io/aws-cdk/versions/0.7.4-beta/ #### `cdk init` Creates a new CDK project. -```shell +```console # List the available template types & languages $ cdk init --list Available templates: @@ -40,7 +40,7 @@ $ cdk init lib --language=typescript #### `cdk list` Lists the stacks modeled in the CDK app. -```shell +```console # List all stacks in the CDK app 'node bin/main.js' $ cdk list --app='node bin/main.js' Foo @@ -76,7 +76,7 @@ will be generated in the output folder for each stack. By default, templates are generated in YAML format. The `--json` option can be used to switch to JSON. -```shell +```console # Generate the template for StackName and output it to STDOUT $ cdk synthesize --app='node bin/main.js' MyStackName @@ -92,7 +92,7 @@ Computes differences between the infrastructure specified in the current state o deployed application (or a user-specified CloudFormation template). This command returns non-zero if any differences are found. -```shell +```console # Diff against the currently deployed stack $ cdk diff --app='node bin/main.js' MyStackName @@ -106,7 +106,7 @@ indications, similar to what can be observed in the AWS CloudFormation Console. bootstrapped (using `cdk bootstrap`), only stacks that are not using assets and synthesize to a template that is under 51,200 bytes will successfully deploy. -```shell +```console $ cdk deploy --app='node bin/main.js' MyStackName ``` @@ -115,7 +115,7 @@ Deletes a stack from it's environment. This will cause the resources in the stac configured with a `DeletionPolicy` of `Retain`). During the stack destruction, the command will output progress information similar to what `cdk deploy` provides. -```shell +```console $ cdk destroy --app='node bin/main.js' MyStackName ``` @@ -124,7 +124,7 @@ Deploys a `CDKToolkit` CloudFormation stack into the specified environment(s), t `cdk deploy` will use to store synthesized templates and the related assets, before triggering a CloudFormation stack update. The name of the deployed stack can be configured using the `--toolkit-stack-name` argument. -```shell +```console # Deploys to all environments $ cdk bootstrap --app='node bin/main.js' @@ -137,7 +137,7 @@ Inspect the current command-line environment and configurations, and collect inf troubleshooting problems. It is usually a good idea to include the information provided by this command when submitting a bug report. -```shell +```console $ cdk doctor ℹ️ CDK Version: 0.7.4-beta (build 0191444) ℹ️ AWS environment variables: From af015c3003fb3aca09fb6ab2f5af7a699c0af255 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=F0=9F=91=A8=F0=9F=8F=BC=E2=80=8D=F0=9F=92=BB=20Romain=20M?= =?UTF-8?q?arcadier-Muller?= Date: Tue, 31 Jul 2018 13:18:44 +0200 Subject: [PATCH 5/8] Prefix comments with $ in shell sessions. --- packages/aws-cdk/README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/packages/aws-cdk/README.md b/packages/aws-cdk/README.md index ff75f4867be1a..f87c71cf320c6 100644 --- a/packages/aws-cdk/README.md +++ b/packages/aws-cdk/README.md @@ -12,11 +12,11 @@ against your currently deployed infrastructure, [deploying](#cdk-deploy) into AW Outputs the URL to the documentation for the current toolkit version, and attempts to open a browser to that URL. ```console -# Open the documentation in the default browser (using 'open') +$ # Open the documentation in the default browser (using 'open') $ cdk docs https://awslabs.github.io/aws-cdk/versions/0.7.4-beta/ -# Open the documentation in Chrome. +$ # Open the documentation in Chrome. $ cdk docs --browser='chrome %u' https://awslabs.github.io/aws-cdk/versions/0.7.4-beta/ ``` @@ -25,7 +25,7 @@ https://awslabs.github.io/aws-cdk/versions/0.7.4-beta/ Creates a new CDK project. ```console -# List the available template types & languages +$ # List the available template types & languages $ cdk init --list Available templates: * app: Template for a CDK Application @@ -33,7 +33,7 @@ Available templates: * lib: Template for a CDK Construct Library └─ cdk init lib --language=typescript -# Create a new library application in typescript +$ # Create a new library application in typescript $ cdk init lib --language=typescript ``` @@ -41,13 +41,13 @@ $ cdk init lib --language=typescript Lists the stacks modeled in the CDK app. ```console -# List all stacks in the CDK app 'node bin/main.js' +$ # List all stacks in the CDK app 'node bin/main.js' $ cdk list --app='node bin/main.js' Foo Bar Baz -# List all stack including all details (add --json to output JSON instead of YAML) +$ # List all stack including all details (add --json to output JSON instead of YAML) $ cdk list --app='node bin/main.js' --long - name: Foo @@ -77,13 +77,13 @@ will be generated in the output folder for each stack. By default, templates are generated in YAML format. The `--json` option can be used to switch to JSON. ```console -# Generate the template for StackName and output it to STDOUT +$ # Generate the template for StackName and output it to STDOUT $ cdk synthesize --app='node bin/main.js' MyStackName -# Generate the template for MyStackName and save it to template.yml +$ # Generate the template for MyStackName and save it to template.yml $ cdk synth --app='node bin/main.js' MyStackName --output=template.yml -# Generate templates for all the stacks and save them into templates/ +$ # Generate templates for all the stacks and save them into templates/ $ cdk synth --app='node bin/main.js' --output=templates ``` @@ -93,10 +93,10 @@ deployed application (or a user-specified CloudFormation template). This command found. ```console -# Diff against the currently deployed stack +$ # Diff against the currently deployed stack $ cdk diff --app='node bin/main.js' MyStackName -# Diff against a specific template document +$ # Diff against a specific template document $ cdk diff --app='node bin/main.js' MyStackName --template=path/to/template.yml ``` @@ -125,10 +125,10 @@ Deploys a `CDKToolkit` CloudFormation stack into the specified environment(s), t update. The name of the deployed stack can be configured using the `--toolkit-stack-name` argument. ```console -# Deploys to all environments +$ # Deploys to all environments $ cdk bootstrap --app='node bin/main.js' -# Deploys only to environments foo and bar +$ # Deploys only to environments foo and bar $ cdk bootstrap --app='node bin/main.js' foo bar ``` From d3073e0b011320f0f328a679cdac9135ca12a9f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=F0=9F=91=A8=F0=9F=8F=BC=E2=80=8D=F0=9F=92=BB=20Romain=20M?= =?UTF-8?q?arcadier-Muller?= Date: Tue, 31 Jul 2018 13:33:02 +0200 Subject: [PATCH 6/8] Table of contents for the commands --- packages/aws-cdk/README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/packages/aws-cdk/README.md b/packages/aws-cdk/README.md index f87c71cf320c6..fb5b0f9f9be09 100644 --- a/packages/aws-cdk/README.md +++ b/packages/aws-cdk/README.md @@ -4,9 +4,18 @@ The AWS CDK Toolkit provides the `cdk` command-line interface that can be used t This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. ### Commands -The `cdk` tool provides commands to manage the whole lifecycle of your CDK app: [creating](#cdk-init) a new project, -[listing](#cdk-list) the stacks in an app, [synthesizing](#cdk-synth) the CloudFormation templates, [diffing](#cdk-diff) -against your currently deployed infrastructure, [deploying](#cdk-deploy) into AWS accounts, and more. +Command | Description +----------------------------------|------------------------------------------------------------------------------------- +[`cdk docs`](#cdk-docs) | Access the online documentation +[`cdk init`](#cdk-init) | Start a new CDK project (app or library) +[`cdk list`](#cdk-list) | List stacks in an application +[`cdk synth`](#cdk-synth) | Synthesize a CDK app to CloudFormation template(s) +[`cdk diff`](#cdk-diff) | Diff stacks against current state +[`cdk deploy`](#cdk-deploy) | Deploy a stack into an AWS account +[`cdk destroy`](#cdk-destroy) | Deletes a stack from an AWS account +[`cdk bootstrap`](#cdk-bootstrap) | Deploy a toolkit stack to support deploying large stacks & artifacts +[`cdk doctor`](#cdk-doctor) | Inspect the environment and produce information useful for troubleshooting + #### `cdk docs` Outputs the URL to the documentation for the current toolkit version, and attempts to open a browser to that URL. From db63f015f943c57401f2ed7725e91e859babb674 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=F0=9F=91=A8=F0=9F=8F=BC=E2=80=8D=F0=9F=92=BB=20Romain=20M?= =?UTF-8?q?arcadier-Muller?= Date: Tue, 31 Jul 2018 13:33:58 +0200 Subject: [PATCH 7/8] Correct anchor --- packages/aws-cdk/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/aws-cdk/README.md b/packages/aws-cdk/README.md index fb5b0f9f9be09..5d7d44155420a 100644 --- a/packages/aws-cdk/README.md +++ b/packages/aws-cdk/README.md @@ -9,7 +9,7 @@ Command | Description [`cdk docs`](#cdk-docs) | Access the online documentation [`cdk init`](#cdk-init) | Start a new CDK project (app or library) [`cdk list`](#cdk-list) | List stacks in an application -[`cdk synth`](#cdk-synth) | Synthesize a CDK app to CloudFormation template(s) +[`cdk synth`](#cdk-synthesize) | Synthesize a CDK app to CloudFormation template(s) [`cdk diff`](#cdk-diff) | Diff stacks against current state [`cdk deploy`](#cdk-deploy) | Deploy a stack into an AWS account [`cdk destroy`](#cdk-destroy) | Deletes a stack from an AWS account From fa821c9cdcdded6e6613e6071f4a9ae5173f7ea4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=F0=9F=91=A8=F0=9F=8F=BC=E2=80=8D=F0=9F=92=BB=20Romain=20M?= =?UTF-8?q?arcadier-Muller?= Date: Tue, 31 Jul 2018 13:36:00 +0200 Subject: [PATCH 8/8] Move TOC before Commands heading --- packages/aws-cdk/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/packages/aws-cdk/README.md b/packages/aws-cdk/README.md index 5d7d44155420a..521b024ca79e0 100644 --- a/packages/aws-cdk/README.md +++ b/packages/aws-cdk/README.md @@ -1,9 +1,6 @@ ## AWS CDK Toolkit The AWS CDK Toolkit provides the `cdk` command-line interface that can be used to work with AWS CDK applications. -This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. - -### Commands Command | Description ----------------------------------|------------------------------------------------------------------------------------- [`cdk docs`](#cdk-docs) | Access the online documentation @@ -16,7 +13,9 @@ Command | Description [`cdk bootstrap`](#cdk-bootstrap) | Deploy a toolkit stack to support deploying large stacks & artifacts [`cdk doctor`](#cdk-doctor) | Inspect the environment and produce information useful for troubleshooting +This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. +### Commands #### `cdk docs` Outputs the URL to the documentation for the current toolkit version, and attempts to open a browser to that URL.