chore: Add doc title to AWS Construct Library (#2722)

Add titles for the `awsdocs` target to the AWS Construct Library packages that are bound to a CloudFormation scope, using the standard capitalization, so the documentation site looks better.
aws · Jun 4, 2019 · ff0ef73 · ff0ef73
1 parent e362ac8
commit ff0ef73
Show file tree

Hide file tree

Showing 186 changed files with 581 additions and 185 deletions.
diff --git a/packages/@aws-cdk/alexa-ask/README.md b/packages/@aws-cdk/alexa-ask/README.md
@@ -1,4 +1,4 @@
-## Alexa Ask Construct Library
+## Alexa Skills Kit Construct Library
 
 ```ts
 const alexaAsk = require('@aws-cdk/alexa-ask');

diff --git a/packages/@aws-cdk/alexa-ask/package.json b/packages/@aws-cdk/alexa-ask/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.alexa-ask",
         "module": "aws_cdk.alexa_ask"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "Alexa Skills Kit"
     }
   },
   "repository": {
@@ -75,4 +78,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/app-delivery/package.json b/packages/@aws-cdk/app-delivery/package.json
@@ -82,4 +82,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/assets-docker/package.json b/packages/@aws-cdk/assets-docker/package.json
@@ -92,4 +92,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/assets/package.json b/packages/@aws-cdk/assets/package.json
@@ -91,4 +91,4 @@
   "bundledDependencies": [
     "minimatch"
   ]
-}
+}
diff --git a/packages/@aws-cdk/aws-amazonmq/README.md b/packages/@aws-cdk/aws-amazonmq/README.md
@@ -1,4 +1,4 @@
-## AWS AmazonMQ Construct Library
+## Amazon MQ Construct Library
 
 ```ts
 const amazonmq = require('@aws-cdk/aws-amazonmq');

diff --git a/packages/@aws-cdk/aws-amazonmq/package.json b/packages/@aws-cdk/aws-amazonmq/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-amazonmq",
         "module": "aws_cdk.aws_amazonmq"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "Amazon MQ"
     }
   },
   "repository": {
@@ -75,4 +78,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-apigateway/README.md b/packages/@aws-cdk/aws-apigateway/README.md
@@ -1,4 +1,4 @@
-## CDK Construct Library for Amazon API Gateway
+## Amazon API Gateway Construct Library
 
 Amazon API Gateway is a fully managed service that makes it easy for developers
 to publish, maintain, monitor, and secure APIs at any scale. Create an API to

diff --git a/packages/@aws-cdk/aws-apigateway/package.json b/packages/@aws-cdk/aws-apigateway/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-apigateway",
         "module": "aws_cdk.aws_apigateway"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "Amazon API Gateway"
     }
   },
   "repository": {
@@ -91,4 +94,4 @@
       "from-method:@aws-cdk/aws-apigateway.Resource"
     ]
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-applicationautoscaling/README.md b/packages/@aws-cdk/aws-applicationautoscaling/README.md
@@ -1,4 +1,4 @@
-## AWS Application AutoScaling Construct Library
+## AWS Auto Scaling Construct Library
 
 **Application AutoScaling** is used to configure autoscaling for all
 services other than scaling EC2 instances. For example, you will use this to

diff --git a/packages/@aws-cdk/aws-applicationautoscaling/package.json b/packages/@aws-cdk/aws-applicationautoscaling/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-applicationautoscaling",
         "module": "aws_cdk.aws_applicationautoscaling"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "AWS Auto Scaling"
     }
   },
   "repository": {
@@ -82,4 +85,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-appmesh/README.md b/packages/@aws-cdk/aws-appmesh/README.md
@@ -1,4 +1,4 @@
-## AWS::AppMesh Construct Library
+## AWS App Mesh Construct Library
 
 This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project.
 

diff --git a/packages/@aws-cdk/aws-appmesh/package.json b/packages/@aws-cdk/aws-appmesh/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-appmesh",
         "module": "aws_cdk.aws_appmesh"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "AWS App Mesh"
     }
   },
   "repository": {
@@ -76,4 +79,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-appstream/README.md b/packages/@aws-cdk/aws-appstream/README.md
@@ -1,4 +1,4 @@
-## AWS AppStream Construct Library
+## Amazon AppStream 2.0 Construct Library
 
 ```ts
 const appstream = require('@aws-cdk/aws-appstream');

diff --git a/packages/@aws-cdk/aws-appstream/package.json b/packages/@aws-cdk/aws-appstream/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-appstream",
         "module": "aws_cdk.aws_appstream"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "Amazon AppStream 2.0"
     }
   },
   "repository": {
@@ -75,4 +78,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-appsync/README.md b/packages/@aws-cdk/aws-appsync/README.md
@@ -1,2 +1,2 @@
-## The CDK Construct Library for AWS AppSync
+## AWS AppSync Construct Library
 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/package.json b/packages/@aws-cdk/aws-appsync/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-appsync",
         "module": "aws_cdk.aws_appsync"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "AWS AppSync"
     }
   },
   "repository": {
@@ -75,4 +78,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-athena/README.md b/packages/@aws-cdk/aws-athena/README.md
@@ -1,2 +1,2 @@
-## The CDK Construct Library for AWS Athena
+## Amazon Athena Construct Library
 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/package.json b/packages/@aws-cdk/aws-athena/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-athena",
         "module": "aws_cdk.aws_athena"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "Amazon Athena"
     }
   },
   "cdk-build": {
@@ -75,4 +78,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-autoscaling-common/package.json b/packages/@aws-cdk/aws-autoscaling-common/package.json
@@ -74,4 +74,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-autoscaling-hooktargets/package.json b/packages/@aws-cdk/aws-autoscaling-hooktargets/package.json
@@ -96,4 +96,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-autoscaling/README.md b/packages/@aws-cdk/aws-autoscaling/README.md
@@ -1,4 +1,4 @@
-## The CDK Construct Library for AWS Auto-Scaling
+## Amazon EC2 Auto Scaling Construct Library
 This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project.
 
 ### Fleet

diff --git a/packages/@aws-cdk/aws-autoscaling/package.json b/packages/@aws-cdk/aws-autoscaling/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-autoscaling",
         "module": "aws_cdk.aws_autoscaling"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "Amazon EC2 Auto Scaling"
     }
   },
   "repository": {
@@ -97,4 +100,4 @@
       "export:@aws-cdk/aws-autoscaling.IAutoScalingGroup"
     ]
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-autoscalingplans/README.md b/packages/@aws-cdk/aws-autoscalingplans/README.md
@@ -1,2 +1,2 @@
-## The CDK Construct Library for AWS Auto-Scaling Plans
+## AWS Auto Scaling Plans Construct Library
 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/package.json b/packages/@aws-cdk/aws-autoscalingplans/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-autoscalingplans",
         "module": "aws_cdk.aws_autoscalingplans"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "AWS Auto Scaling Plans"
     }
   },
   "repository": {
@@ -75,4 +78,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-batch/README.md b/packages/@aws-cdk/aws-batch/README.md
@@ -1,2 +1,2 @@
-## The CDK Construct Library for AWS Batch
+## AWS Batch Construct Library
 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/package.json b/packages/@aws-cdk/aws-batch/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-batch",
         "module": "aws_cdk.aws_batch"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "AWS Batch"
     }
   },
   "repository": {
@@ -75,4 +78,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-budgets/README.md b/packages/@aws-cdk/aws-budgets/README.md
@@ -1,2 +1,2 @@
-## The CDK Construct Library for AWS Budgets
+## AWS Budgets Construct Library
 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/package.json b/packages/@aws-cdk/aws-budgets/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-budgets",
         "module": "aws_cdk.aws_budgets"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "AWS Budgets"
     }
   },
   "repository": {
@@ -75,4 +78,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-certificatemanager/README.md b/packages/@aws-cdk/aws-certificatemanager/README.md
@@ -1,4 +1,4 @@
-## AWS Certificate Manager Construct Library
+## Amazon Certificate Manager Construct Library
 
 This package provides Constructs for provisioning and referencing certificates which
 can be used in CloudFront and ELB.

diff --git a/packages/@aws-cdk/aws-certificatemanager/package.json b/packages/@aws-cdk/aws-certificatemanager/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-certificatemanager",
         "module": "aws_cdk.aws_certificatemanager"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "Amazon Certificate Manager"
     }
   },
   "repository": {
@@ -83,4 +86,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-cloud9/README.md b/packages/@aws-cdk/aws-cloud9/README.md
@@ -1,2 +1,2 @@
-## The CDK Construct Library for AWS Cloud9
+## AWS Cloud9 Construct Library
 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/package.json b/packages/@aws-cdk/aws-cloud9/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-cloud9",
         "module": "aws_cdk.aws_cloud9"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "AWS Cloud9"
     }
   },
   "repository": {
@@ -75,4 +78,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-cloudformation/README.md b/packages/@aws-cdk/aws-cloudformation/README.md
@@ -1,4 +1,4 @@
-## CDK Constructs for AWS CloudFormation
+## AWS CloudFormation Construct Library
 
 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/package.json b/packages/@aws-cdk/aws-cloudformation/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-cloudformation",
         "module": "aws_cdk.aws_cloudformation"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "AWS CloudFormation"
     }
   },
   "repository": {
@@ -100,4 +103,4 @@
       "construct-ctor-props-optional:@aws-cdk/aws-cloudformation.AwsCustomResource"
     ]
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-cloudfront/README.md b/packages/@aws-cdk/aws-cloudfront/README.md
@@ -1,4 +1,4 @@
-## AWS CloudFront Construct Library
+## Amazon CloudFront Construct Library
 A CloudFront construct - for setting up the AWS CDN with ease!
 
 Example usage:

diff --git a/packages/@aws-cdk/aws-cloudfront/package.json b/packages/@aws-cdk/aws-cloudfront/package.json
@@ -24,6 +24,9 @@
         "distName": "aws-cdk.aws-cloudfront",
         "module": "aws_cdk.aws_cloudfront"
       }
+    },
+    "metadata": {
+      "awsdocs:title": "Amazon CloudFront"
     }
   },
   "repository": {
@@ -85,4 +88,4 @@
   "engines": {
     "node": ">= 8.10.0"
   }
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -82,4 +82,4 @@ @@
       "engines": {
         "node": ">= 8.10.0"
       }
-    }
+    }