chore: update initial set of example READMEs

coder · khorne3 · Jun 6, 2022 · May 31, 2022 · May 31, 2022 · May 31, 2022
commit c6ad14aa1b48517ef4ef06fa84c9c9633dacdbdf
diff --git a/examples/templates/aws-linux/README.md b/examples/templates/aws-linux/README.md
@@ -8,11 +8,13 @@ tags: [cloud, aws]
 
 ## Getting started
 
-Pick this template in `coder templates init` and follow instructions.
+Run `coder templates init`, and when prompted, select this template. Follow the
+on-screen instructions to proceed.
 
 ## Required permissions / policy
 
-This example policy allows Coder to create EC2 instances and modify instances provisioned by Coder.
+The following sample policy allows Coder to create EC2 instances and modify
+instances provisioned by Coder:
 
 ```json
 {
@@ -61,4 +63,3 @@ This example policy allows Coder to create EC2 instances and modify instances pr
     ]
 }
 ```
-
diff --git a/examples/templates/aws-windows/README.md b/examples/templates/aws-windows/README.md
@@ -3,3 +3,10 @@ name: Develop in Windows on AWS
 description: Get started with Windows development on AWS.
 tags: [cloud, aws]
 ---
+
+# aws-windows
+
+## Getting started
+
+Run `coder templates init`, and when prompted, select this template. Follow the
+on-screen instructions to proceed.
diff --git a/examples/templates/docker/README.md b/examples/templates/docker/README.md
@@ -8,17 +8,22 @@ tags: [local, docker]
 
 ## Getting started
 
-Run `coder templates init` and select this template. Follow the instructions that appear. 
+Run `coder templates init`, and when prompted, select this template. Follow the
+on-screen instructions to proceed.
 
 ## Adding/removing images
 
-After building and pushing an image to an image registry (e.g., DockerHub), you can edit the template to make the image available to users. 
-
-Edit the template:
+After building and pushing an image to an image registry (e.g., DockerHub), edit
+the template to make the image available to users:
 
 ```sh
+# Open the template
 vim main.tf
 ```
+
+Modify your file to match the following:
+
+```dockerfile
 variable "docker_image" {
   description = "What Docker image would you like to use for your workspace?"
   default     = "codercom/enterprise-base:ubuntu"
@@ -77,4 +82,3 @@ add the following features to your Coder template:
 - More
 
 We also welcome contributions!
-
diff --git a/examples/templates/gcp-linux/README.md b/examples/templates/gcp-linux/README.md
@@ -3,3 +3,23 @@ name: Develop in Linux on Google Cloud
 description: Get started with Linux development on Google Cloud.
 tags: [cloud, google]
 ---
+
+# gcp-linux
+
+## Getting Started
+
+Run `coder templates init`, and when prompted, select this template. Follow the
+on-screen instructions to proceed.
+
+## Service account
+
+Coder requires a Google Cloud Service Account to provision workspaces. To create
+a service account:
+
+1. Navigate to the [CGP console](https://console.cloud.google.com/projectselector/iam-admin/serviceaccounts/create).
+2. Add the following roles:
+   - Compute Admin
+   - Service Account User
+3. Click on the created key, and navigate to the **Keys** tab.
+4. Click **Add key** > **Create new key**.
+5. Generate a **JSON private key**, which will be what you provide to coder.
diff --git a/examples/templates/gcp-vm-container/README.md b/examples/templates/gcp-vm-container/README.md
@@ -3,3 +3,23 @@ name: Develop in a container on a Google Cloud VM
 description: Get started with Linux development on Google Cloud.
 tags: [cloud, google, container]
 ---
+
+# gcp-vm-container
+
+## Getting Started
+
+Run `coder templates init`, and when prompted, select this template. Follow the
+on-screen instructions to proceed.
+
+## Service account
+
+Coder requires a Google Cloud Service Account to provision workspaces. To create
+a service account:
+
+1. Navigate to the [CGP console](https://console.cloud.google.com/projectselector/iam-admin/serviceaccounts/create).
+2. Add the following roles:
+   - Compute Admin
+   - Service Account User
+3. Click on the created key, and navigate to the **Keys** tab.
+4. Click **Add key** > **Create new key**.
+5. Generate a **JSON private key**, which will be what you provide to coder.
diff --git a/examples/templates/gcp-windows/README.md b/examples/templates/gcp-windows/README.md
@@ -3,3 +3,23 @@ name: Develop in Windows on Google Cloud
 description: Get started with Windows development on Google Cloud.
 tags: [cloud, google]
 ---
+
+# gcp-windows
+
+## Getting Started
+
+Run `coder templates init`, and when prompted, select this template. Follow the
+on-screen instructions to proceed.
+
+## Service account
+
+Coder requires a Google Cloud Service Account to provision workspaces. To create
+a service account:
+
+1. Navigate to the [CGP console](https://console.cloud.google.com/projectselector/iam-admin/serviceaccounts/create).
+2. Add the following roles:
+   - Compute Admin
+   - Service Account User
+3. Click on the created key, and navigate to the **Keys** tab.
+4. Click **Add key** > **Create new key**.
+5. Generate a **JSON private key**, which will be what you provide to coder.