Clean up tutorial titles (pulumi#396)

* Clean up tutorial titles Signed-off-by: bermudezmt <[email protected]> * More title cleanup Signed-off-by: bermudezmt <[email protected]> * Update aws-ts-static-website/README.md Co-Authored-By: Justin Van Patten <[email protected]> * Update cloud-ts-voting-app/README.md Co-Authored-By: Justin Van Patten <[email protected]> * Additional title cleanup * Clean up Fargate Container tutorial (AWS + JS) * Address Mikhail's feedback Signed-off-by: bermudezmt <[email protected]>
cbenjemaa · Sep 20, 2019 · ab689f5 · ab689f5
1 parent 9d9fc3d
commit ab689f5
Show file tree

Hide file tree

Showing 59 changed files with 99 additions and 90 deletions.
diff --git a/aws-go-s3-folder/README.md b/aws-go-s3-folder/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Static Website Hosted on AWS S3 in Go
+# Host a Static Website on Amazon S3
 
 A static website that uses [S3's website support](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
 For a detailed walkthrough of this example, see the tutorial [Static Website on AWS S3](https://www.pulumi.com/docs/tutorials/aws/s3-website/).

diff --git a/aws-js-containers/README.md b/aws-js-containers/README.md
@@ -1,39 +1,48 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Easy container example
+# ECS Fargate Containers
 
 Companion to the tutorial [Provision containers on AWS](https://www.pulumi.com/docs/tutorials/aws/ecs-fargate/).
 
 ## Prerequisites
 
-To run this example, make sure [Docker](https://docs.docker.com/engine/installation/) is installed and running.
+To run this example, make sure [Docker Engine - Community](https://docs.docker.com/engine/installation/) is installed and running.
 
-## Running the App
+## Deploy the App
 
 Note: some values in this example will be different from run to run. These values are indicated
 with `***`.
 
-1. Create a new stack:
+### Step 1: Create a new stack
 
  ```
  $ pulumi stack init containers-dev
  ```
 
-1. Configure Pulumi to use an AWS region that supports Fargate. This is currently only available in `us-east-1`, `us-east-2`, `us-west-2`, and `eu-west-1`:
+### Step 2: Configure AWS region for Pulumi
+
+For this example, you need to set an AWS region that supports Fargate. Refer to the [AWS Region Table](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/) for product availability.
 
  ```
  $ pulumi config set aws:region us-west-2
  ```
 
-1. Restore NPM modules via `npm install` or `yarn install`.
+### Step 3: Restore NPM modules
+
+You can do this via `npm install` or `yarn install`.
+
+### Step 4:. Preview and deploy the app
 
-1. Preview and deploy the app via `pulumi up`. The preview will take a few minutes, as it builds a Docker container. A total of 19 resources are created.
+Run the following command:
 
  ```
  $ pulumi up
  ```
+The preview will take a few minutes, as it builds a Docker container. A total of 19 resources are created.
 
-1. View the endpoint URL, and run curl:
+### Step 5: View the endpoint URL
+
+Run [`pulumi stack output`](https://www.pulumi.com/docs/reference/cli/pulumi_stack_output/) to view your stack's output properties, and then `curl` the command to view the resulting page. `$(pulumi stack output url)` evaluates to the load balancer’s URL.
 
  ```bash
  $ pulumi stack output
@@ -51,15 +60,17 @@ with `***`.
  </body></html>
  ```
 
-1. To view the runtime logs from the container, use the `pulumi logs` command. To get a log stream, use `pulumi logs --follow`.
+### Step 6: View runtime logs from the container
+
+Use the [`pulumi logs`](https://www.pulumi.com/docs/reference/cli/pulumi_logs/) command. To get a log stream, use `pulumi logs --follow`.
 
  ```
  $ pulumi logs --follow
  Collecting logs for stack container-quickstart-dev since 2018-05-22T14:25:46.000-07:00.
  2018-05-22T15:33:22.057-07:00[ pulumi-nginx] 172.31.13.248 - - [22/May/2018:22:33:22 +0000] "GET / HTTP/1.1" 200 189 "-" "curl/7.54.0" "-"
  ```
 
-## Clean up
+## Clean Up
 
-To clean up resources, run `pulumi destroy` and answer the confirmation question at the prompt.
+To clean up resources, run [`pulumi destroy`](https://www.pulumi.com/docs/reference/cli/pulumi_destroy/) to avoid incurring any costs. Select `yes` on the confirmation prompt so Pulumi will remove all of the resources that you've created. To delete the stack itself, run [`pulumi stack rm`](https://www.pulumi.com/docs/reference/cli/pulumi_stack_rm/). Note that this command deletes all deployment history from the Pulumi Console, unless you've explicitly [chosen a different backend](https://www.pulumi.com/docs/intro/concepts/state/) for storing your infrastructure state.
 
diff --git a/aws-js-s3-folder/README.md b/aws-js-s3-folder/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Static Website Hosted on AWS S3
+# Host a Static Website on Amazon S3
 
 A static website that uses [S3's website support](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
 For a detailed walkthrough of this example, see the tutorial [Static Website on AWS S3](https://www.pulumi.com/docs/tutorials/aws/s3-website/).

diff --git a/aws-js-webserver-component/README.md b/aws-js-webserver-component/README.md
@@ -1,7 +1,7 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# AWS Web Server component example
+# AWS Web Server Component
 
-Deploy an EC2 instance using `@pulumi/aws`, using a common module for creating an instance. A function `createInstance` is defined in [webserver.js](webserver.js) which is then used in main program.
+Deploy an EC2 instance with the `@pulumi/aws` package, using a common module for creating an instance. We define a function, `createInstance`, in [webserver.js](webserver.js) and use it in the main program, [index.js](index.js).
 
-For a walkthrough of the main example, [Infrastructure on AWS](https://www.pulumi.com/docs/tutorials/aws/ec2-webserver/).
+For a walkthrough of the main example, see [Simple Web Server Using Amazon EC2](https://www.pulumi.com/docs/tutorials/aws/ec2-webserver/).
diff --git a/aws-js-webserver/README.md b/aws-js-webserver/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# AWS EC2 Web Server
+# Web Server Using Amazon EC2
 
 This example deploys a simple AWS EC2 virtual machine running a Python web server.
 

diff --git a/aws-py-s3-folder/README.md b/aws-py-s3-folder/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Static Website Hosted on AWS S3
+# Host a Static Website on Amazon S3
 
 A static website that uses [S3's website support](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
 For a detailed walkthrough of this example, see the tutorial [Static Website on AWS S3](https://www.pulumi.com/docs/tutorials/aws/s3-website/).

diff --git a/aws-py-stepfunctions/README.md b/aws-py-stepfunctions/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# AWS Step Functions (Python)
+# AWS Step Functions
 
 A basic example that demonstrates using AWS Step Functions with a Lambda function, written in Python.
 

diff --git a/aws-py-webserver/README.md b/aws-py-webserver/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# AWS Web Server example in Python
+# Web Server Using Amazon EC2
 
 An example based on the Amazon sample at:
 http:https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/deploying.applications.html. The example deploys an EC2 instance and opens port 80. 

diff --git a/aws-ts-airflow/README.md b/aws-ts-airflow/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# AWS RDS and Airflow example
+# RDS Postgres and Containerized Airflow
 
 A Pulumi program to deploy an RDS Postgres instance and containerized Airflow.
 

diff --git a/aws-ts-apigateway-auth0/README.md b/aws-ts-apigateway-auth0/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Auth0 Protected Serverless REST API on AWS
+# Secure Serverless REST API Using Auth0
 
 A simple REST API that is protected by a custom AWS Lambda Authorizer. The Authorizer uses [Auth0](https://auth0.com/) to authorize requests.
 

diff --git a/aws-ts-apigateway/README.md b/aws-ts-apigateway/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Serverless REST API on AWS
+# Serverless REST API
 
 A simple REST API that counts the number of times a route has been hit. For a detailed walkthrough of this example, see the article [Create a Serverless REST API](https://www.pulumi.com/docs/tutorials/aws/rest-api/).
 

diff --git a/aws-ts-appsync/README.md b/aws-ts-appsync/README.md
@@ -1,8 +1,8 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Defining an AWS AppSync Endpoint
+# GraphQL Endpoint in AWS AppSync
 
-This example shows how to setup a basic GraphQL endpoint in AWS AppSync. The endpoint contains one query and one mutation that get and put items to a Dynamo DB table.
+This example shows how to set up a basic GraphQL endpoint in AWS AppSync. The endpoint contains one query and one mutation that get and put items to a Dynamo DB table.
 
 ## Deploying and running the Pulumi App
 

diff --git a/aws-ts-assume-role/README.md b/aws-ts-assume-role/README.md
@@ -1,9 +1,9 @@
-# AWS AssumeRole Example
+# AWS Resources Using AssumeRole
 
 This example demonstrates how to use the AssumeRole functionality of the AWS provider in order to create resources in
 the security context of an IAM Role assumed by the IAM User running the Pulumi program.
 
-## Deploying the Example 
+## Deploying the Example
 
 These instructions assume you are familiar with running Pulumi programs written in TypeScript. Some other examples which
 describe each step in more detail are:

diff --git a/aws-ts-eks-hello-world/README.md b/aws-ts-eks-hello-world/README.md
@@ -1,9 +1,8 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# AWS EKS Cluster
+# Amazon EKS Cluster: Hello World!
 
-This example deploys an EKS Kubernetes cluster with an EBS-backed StorageClass, and deploys a Kubernetes Namespace and Deployment of NGINX
-into the cluster.
+This example deploys an EKS Kubernetes cluster with an EBS-backed StorageClass, and deploys a Kubernetes Namespace and Deployment of NGINX into the cluster.
 
 ## Deploying the App
 
@@ -215,7 +214,7 @@ After cloning this repo, from this working directory, run these commands:
  the NGINX app, and a LoadBalancer `Service` to publicly access NGINX.
 
  Pulumi understands which changes to a given cloud resource can be made
- in-place, and which require replacement, and computes
+ in place, and which require replacement, and computes
  the minimally disruptive change to achieve the desired state.
 
  > **Note:** Pulumi auto-generates a suffix for all objects.
@@ -230,12 +229,12 @@ After cloning this repo, from this working directory, run these commands:
  > ```
 
  If you visit the FQDN listed in `serviceHostname` you should land on the
- NGINX welcome page. Note, that it may take a minute or so for the
+ NGINX welcome page. Note that it may take a minute or so for the
  LoadBalancer to become active on AWS.
 
 1. Access the Kubernetes Cluster using `kubectl`
 
- To access your new Kubernetes cluster using `kubectl`, we need to setup the
+ To access your new Kubernetes cluster using `kubectl`, we need to set up the
  `kubeconfig` file and download `kubectl`. We can leverage the Pulumi
  stack output in the CLI, as Pulumi faciliates exporting these objects for us.
 
@@ -265,12 +264,11 @@ After cloning this repo, from this working directory, run these commands:
  $ kubectl delete deployment my-nginx
  ```
 
- By deploying this nginx image in this way, it is outside of Pulumi's control. But this is simply to show that we can
- control our cluster via the CLI as well. 
+ By deploying the NGINX image in this way, it is outside of Pulumi's control. But this is simply to show that we can control our cluster via the CLI as well.
 
 1. Experimentation
 
- From here on, feel free to experiment. Simply making edits and running `pulumi up` afterwards, will incrementally update your stack.
+ From here on, feel free to experiment. Make edits and run `pulumi up` afterwards to incrementally update your stack.
 
   ### Running Off-the-Shelf Guestbook YAML
 

diff --git a/aws-ts-eks-migrate-nodegroups/README.md b/aws-ts-eks-migrate-nodegroups/README.md
@@ -1,8 +1,9 @@
-# examples/aws-ts-eks-migrate-nodegroups
+# Zero Downtime Migration of EKS Node Groups
 
-Creates an EKS cluster with node groups and a workload, and showcases how add an
-additional node group to use for workload migration with zero downtime.
+Creates an EKS cluster with node groups and a workload, and showcases adding a
+node group to use for workload migration with zero downtime.
 
 For step-by-step instructions, check out the [tutorial][tutorial-migrate-nodegroups].
 
 [tutorial-migrate-nodegroups]: https://www.pulumi.com/docs/tutorials/kubernetes/eks-migrate-nodegroups/
+
diff --git a/aws-ts-eks/README.md b/aws-ts-eks/README.md
@@ -1,9 +1,8 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# AWS EKS Cluster
+# Kubernetes Dashboard on an Amazon EKS Cluster
 
-This example deploys an EKS Kubernetes cluster with an EBS-backed StorageClass and deploys the Kubernetes Dashboard
-into the cluster.
+This example deploys an EKS Kubernetes cluster with an EBS-backed StorageClass and deploys the Kubernetes Dashboard into the cluster.
 
 ## Deploying the App
 
@@ -113,10 +112,10 @@ After cloning this repo, from this working directory, run these commands:
  browser.
  - Choose `Token` authentication, paste the token retrieved earlier into the `Token` field, and sign in.
 
-7. From there, feel free to experiment. Simply making edits and running `pulumi up` will incrementally update your stack.
- For example, in order to deploy a Helm chart into your cluster, simply import the `@pulumi/kubernetes/helm` package,
+7. From there, feel free to experiment. Make edits and run `pulumi up` to incrementally update your stack.
+ For example, in order to deploy a Helm chart into your cluster, import the `@pulumi/kubernetes/helm` package,
  add a `Chart` resource that targets the EKS cluster to `index.ts`, and run `pulumi up`. Note that the Helm client
- must be set up in order for the chart to deploy; see the "Prerequisites" section for details.
+ must be set up in order for the chart to deploy. For more details, see the [Prerequisites](#prerequisites) list.
 
  ```typescript
  import * as helm from "@pulumi/kubernetes/helm";

diff --git a/aws-ts-hello-fargate/README.md b/aws-ts-hello-fargate/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Get Started with Docker on AWS Fargate
+# Dockerized App Using ECS, ECR, and Fargate
 
 This example, inspired by the [Docker Getting Started Tutorial](https://docs.docker.com/get-started/), builds, deploys,
 and runs a simple containerized application to a private container registry, and scales out five load balanced replicas,

diff --git a/aws-ts-ruby-on-rails/README.md b/aws-ts-ruby-on-rails/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# AWS EC2 Ruby on Rails
+# Ruby on Rails Server Using Amazon EC2
 
 This is a conversion of the AWS CloudFormation Application Framework template for a basic Ruby on Rails server.
 It creates a single EC2 virtual machine instance and uses a local MySQL database for storage. Sourced from

diff --git a/aws-ts-s3-lambda-copyzip/README.md b/aws-ts-s3-lambda-copyzip/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Serverless App to Copy and Zip S3 Objects Between Buckets
+# Serverless App to Copy and Zip Objects Between Amazon S3 Buckets
 
 This example sets up two AWS S3 Buckets and a single Lambda that listens to one and, upon each new
 object arriving in it, zips it up and copies it to the second bucket. Its architecture looks like this:

diff --git a/aws-ts-serverless-raw/README.md b/aws-ts-serverless-raw/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# serverless-raw
+# Serverless C# App
 
 This example deploys a complete serverless C# application using raw `aws.apigateway.RestAPI`, `aws.lambda.Function` and
 `aws.dynamodb.Table` resources from `@pulumi/aws`. Although this doesn't feature any of the higher-level abstractions

diff --git a/aws-ts-slackbot/README.md b/aws-ts-slackbot/README.md
@@ -1,8 +1,8 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# A simple Slackbot running in AWS using Pulumi.
+# Slackbot for Posting Slack Mention Notifications
 
-A simple Slackbot (called '@mentionbot') that sends a message to specific channel to notifiy you any time you're @mentioned anywhere. Very helpful if you want a time-ordered list of @mentions to go through at a later point.
+A simple Slackbot (called '@mentionbot') that sends a message to specific channel to notify you any time you're @mentioned anywhere. This bot is useful for when you need a time-ordered list of @mentions to go through at a later point.
 
 Slack users can subscribe/unsubscribe from notifications easily. Simply add `@mentionbot` to a channel you want to be notified in. Then send any message to `@mentionbot` to subscribe. To stop getting messages send a message to `@mentionbot` containing the word `unsubscribe`.
 

diff --git a/aws-ts-static-website/README.md b/aws-ts-static-website/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Static Website using AWS and TypeScript
+# Secure Static Website Using Amazon S3, CloudFront, Route53, and Certificate Manager
 
 This example serves a static website using TypeScript and AWS.
 

diff --git a/aws-ts-thumbnailer/README.md b/aws-ts-thumbnailer/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Video Thumbnailer
+# Video Thumbnailer Using AWS Fargate
 
 A video thumbnail extractor using serverless functions and containers.
 

diff --git a/aws-ts-voting-app/README.md b/aws-ts-voting-app/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Voting app with two containers
+# Voting app Using Redis and Flask
 
 A simple voting app that uses Redis for a data store and a Python Flask app for the frontend. The example has been ported from https://github.com/Azure-Samples/azure-voting-app-redis.
 

diff --git a/azure-js-webserver/README.md b/azure-js-webserver/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Pulumi web server (Azure)
+# Web Server Using Azure Virtual Machine
 
 Starting point for building the Pulumi web server sample in Azure.
 

diff --git a/azure-py-webserver/README.md b/azure-py-webserver/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Azure Web Server example in Python
+# Web Server Using Azure Virtual Machine
 
 This example deploys an Azure Virtual Machine and starts a HTTP server on it.
 

diff --git a/azure-ts-aks-keda/README.md b/azure-ts-aks-keda/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Azure Kubernetes Service (AKS) cluster and Azure Functions with KEDA
+# Azure Kubernetes Service (AKS) Cluster and Azure Functions with KEDA
 
 This example demonstrates creating an Azure Kubernetes Service (AKS) Cluster, and deploying an Azure Function App with Kubernetes-based Event Driven Autoscaling (KEDA) into it, all in one Pulumi program. Please see https://docs.microsoft.com/en-us/azure/aks/ for more information about AKS and https://docs.microsoft.com/en-us/azure/azure-functions/functions-kubernetes-keda for more information about KEDA.
 

diff --git a/azure-ts-aks-mean/README.md b/azure-ts-aks-mean/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# A Node.js demo app deployed on AKS, using CosmosDB
+# Azure Kubernetes Service (AKS) App Using CosmosDB
 
 Stands up an [Azure Kubernetes Service][aks] (AKS) cluster and a MongoDB-flavored instance of
 [CosmosDB][cosmos]. On top of the AKS cluster, we also deploy [Helm][helm] Chart with a simple

diff --git a/azure-ts-appservice-devops/README.md b/azure-ts-appservice-devops/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new?template=https://github.com/pulumi/examples/tree/master/azure-ts-appservice-devops/infra)
 
-# A Todo App on Azure App Service with SQL Database and Application Insights and deploys it to Azure DevOps
+# Todo App Using Azure App Service with SQL Database and Integrated with Azure DevOps
 
 A Todo List application from Azure Samples GitHub: [.NET Core MVC sample for Azure App Service](https://github.com/azure-samples/dotnetcore-sqldb-tutorial), a web app built with ASP.NET Core, Entity Framework Core and a SQL database. 
 

diff --git a/azure-ts-appservice-docker/README.md b/azure-ts-appservice-docker/README.md
@@ -1,6 +1,6 @@
 [![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
 
-# Azure App Service running Docker containers on Linux
+# Azure App Service Running Docker Containers on Linux
 
 Starting point for building web application hosted in Azure App Service from Docker images.
 

diff --git a/azure-ts-appservice-springboot/README.md b/azure-ts-appservice-springboot/README.md
@@ -1,4 +1,4 @@
-# Deploy a Spring Boot App using Jenkins and Pulumi
+# Spring Boot App on Azure App Service Using Jenkins
 
 This example shows how you can deploy a Spring Boot app to an Azure App Service instance using Pulumi in a Jenkins Pipeline. The Spring Boot app is packaged into a container image that is conveniently built as part of the Pulumi app. The container image is pushed up to a private Azure Container Registry and then used as the source for an App Service instance.