fixes from feedback

bpmct · bpmct · commit a747cec844e4 · 2022-05-18T18:21:42.000Z
diff --git a/examples/docker-image-builds/README.md b/examples/docker-image-builds/README.md
@@ -54,15 +54,15 @@ Edit the validation to include the new image:
 
 ```diff
 variable "docker_image" {
-    description = "What docker image would you like to use for your workspace?"
+    description = "What Docker imagewould you like to use for your workspace?"
     default     = "base"
 
     # List of images available for the user to choose from.
     # Delete this condition to give users free text input.
     validation {
 -       condition     = contains(["base", "java", "node"], var.docker_image)
 +       condition     = contains(["base", "java", "node", "golang], var.docker_image)
-        error_message = "Invalid Docker Image!"
+        error_message = "Invalid Docker image!"
     }
 }
 ```
@@ -91,11 +91,11 @@ coder template update docker-image-builds
 ```
 
 You can also remove images from the validation list. Workspaces using older template versions will continue using
-the removed image until the workspace is updated to the latest version.
+the removed image until you update the workspace to the latest version.
 
 ## Updating images
 
-Edit the Dockerfile (or related assets)
+Edit the Dockerfile (or related assets):
 
 ```sh
 vim images/node.Dockerfile
@@ -109,7 +109,7 @@ RUN DEBIAN_FRONTEND="noninteractive" apt-get update -y && \
     apt-get install -y nodejs
 ```
 
-1. Edit the template Terraform (`main.tf`)
+1. Edit the Terraform template (`main.tf`)
 
 ```sh
 vim main.tf
@@ -156,4 +156,4 @@ add the following features to your Coder template:
 - Custom container spec
 - More
 
-Contributions are also welcome!
+We also welcome all contributions!
diff --git a/examples/docker-image-builds/images/java.Dockerfile b/examples/docker-image-builds/images/java.Dockerfile
@@ -18,13 +18,13 @@ ENV MAVEN_HOME /usr/share/maven
 ENV MAVEN_CONFIG "/home/coder/.m2"
 
 RUN mkdir -p $MAVEN_HOME $MAVEN_HOME/ref \
-    && echo "Downloading maven" \
+    && echo "Downloading Maven" \
     && curl -fsSL -o /tmp/apache-maven.tar.gz https://apache.osuosl.org/maven/maven-3/${MAVEN_VERSION}/binaries/apache-maven-${MAVEN_VERSION}-bin.tar.gz \
     \
     && echo "Checking downloaded file hash" \
     && echo "${MAVEN_SHA512}  /tmp/apache-maven.tar.gz" | sha512sum -c - \
     \
-    && echo "Unzipping maven" \
+    && echo "Unzipping Maven" \
     && tar -xzf /tmp/apache-maven.tar.gz -C $MAVEN_HOME --strip-components=1 \
     \
     && echo "Cleaning and setting links" \
@@ -38,7 +38,7 @@ ARG GRADLE_SHA512=d495bc65379d2a854d2cca843bd2eeb94f381e5a7dcae89e6ceb6ef4c58355
 ENV GRADLE_HOME /usr/bin/gradle
 
 RUN mkdir -p /usr/share/gradle /usr/share/gradle/ref \
-    && echo "Downloading gradle" \
+    && echo "Downloading Gradle" \
     && curl -fsSL -o /tmp/gradle.zip https://services.gradle.org/distributions/gradle-${GRADLE_VERSION}-bin.zip \
     \
     && echo "Checking downloaded file hash" \
diff --git a/examples/docker-image-builds/main.tf b/examples/docker-image-builds/main.tf
@@ -32,7 +32,7 @@ variable "step2_arch" {
   description = "arch: What archicture is your Docker host on?"
   validation {
     condition     = contains(["amd64", "arm64", "armv7"], var.step2_arch)
-    error_message = "Value must be amd64, arm64 or armv7."
+    error_message = "Value must be amd64, arm64, or armv7."
   }
   sensitive = true
 }
@@ -54,20 +54,20 @@ resource "coder_agent" "dev" {
 }
 
 variable "docker_image" {
-  description = "What docker image would you like to use for your workspace?"
+  description = "What Docker imagewould you like to use for your workspace?"
   default     = "base"
 
   # List of images available for the user to choose from.
   # Delete this condition to give users free text input.
   validation {
     condition     = contains(["base", "java", "node"], var.docker_image)
-    error_message = "Invalid Docker Image!"
+    error_message = "Invalid Docker image!"
   }
 
   # Prevents admin errors when the image is not found
   validation {
     condition     = fileexists("images/${var.docker_image}.Dockerfile")
-    error_message = "Invalid docker image. The file does not exist in the images directory."
+    error_message = "Invalid Docker image. The file does not exist in the images directory."
   }
 }
 
diff --git a/examples/docker/README.md b/examples/docker/README.md
@@ -8,26 +8,25 @@ tags: [local, docker]
 
 ## Getting started
 
-Pick this template in `coder templates init` and follow instructions. 
+Run `coder templates init` and select this template. Follow the instructions that appear. 
 
 ## Adding/removing images
 
-After building and pushing an image to an image registry (e.g DockerHub), you can make the
-image available to users in the template. 
+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:
 
 ```sh
 vim main.tf
 ```
 variable "docker_image" {
-  description = "What docker image would you like to use for your workspace?"
+  description = "What Docker imagewould you like to use for your workspace?"
   default     = "codercom/enterprise-base:ubuntu"
   validation {
 -    condition     = contains(["codercom/enterprise-base:ubuntu", "codercom/enterprise-node:ubuntu", "codercom/enterprise-intellij:ubuntu"], var.docker_image)
 +    condition     = contains(["codercom/enterprise-base:ubuntu", "codercom/enterprise-node:ubuntu", "codercom/enterprise-intellij:ubuntu", "codercom/enterprise-golang:ubuntu"], var.docker_image)
 
-    error_message = "Invalid Docker Image!"
+    error_message = "Invalid Docker image!"
   }
 }
 ```
@@ -38,16 +37,16 @@ Update the template:
 coder template update docker
 ```
 
-Images can also be removed from the validation list. Workspaces using older template versions will continue using
-the removed image until the workspace is updated to the latest version.
+You can also remove images from the validation list. Workspaces using older template versions will continue using
+the removed image until you update the workspace to the latest version.
 
 ## Updating images
 
-To reduce drift, we recommend versioning images in your registry via tags. Update the image tag in the template:
+To reduce drift, we recommend versioning images in your registry by creating tags. To update the image tag in the template:
 
 ```sh
 variable "docker_image" {
-  description = "What docker image would you like to use for your workspace?"
+  description = "What Docker imagewould you like to use for your workspace?"
   default     = "codercom/enterprise-base:ubuntu"
   validation {
 -    condition     = contains(["my-org/base-development:v1.1", "myorg-java-development:v1.1"], var.docker_image)
diff --git a/examples/docker/main.tf b/examples/docker/main.tf
@@ -66,7 +66,7 @@ variable "docker_image" {
   default = "codercom/enterprise-base:ubuntu"
   validation {
     condition     = contains(["codercom/enterprise-base:ubuntu", "codercom/enterprise-node:ubuntu", "codercom/enterprise-intellij:ubuntu"], var.docker_image)
-    error_message = "Invalid Docker Image!"
+    error_message = "Invalid Docker image!"
   }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -18,13 +18,13 @@ ENV MAVEN_HOME /usr/share/maven`
`18`	`18`	`ENV MAVEN_CONFIG "/home/coder/.m2"`
`19`	`19`
`20`	`20`	`RUN mkdir -p $MAVEN_HOME $MAVEN_HOME/ref \`
`21`		`- && echo "Downloading maven" \`
	`21`	`+ && echo "Downloading Maven" \`
`22`	`22`	`&& curl -fsSL -o /tmp/apache-maven.tar.gz https://apache.osuosl.org/maven/maven-3/${MAVEN_VERSION}/binaries/apache-maven-${MAVEN_VERSION}-bin.tar.gz \`
`23`	`23`	`\`
`24`	`24`	`&& echo "Checking downloaded file hash" \`
`25`	`25`	`&& echo "${MAVEN_SHA512} /tmp/apache-maven.tar.gz" \| sha512sum -c - \`
`26`	`26`	`\`
`27`		`- && echo "Unzipping maven" \`
	`27`	`+ && echo "Unzipping Maven" \`
`28`	`28`	`&& tar -xzf /tmp/apache-maven.tar.gz -C $MAVEN_HOME --strip-components=1 \`
`29`	`29`	`\`
`30`	`30`	`&& echo "Cleaning and setting links" \`
`@@ -38,7 +38,7 @@ ARG GRADLE_SHA512=d495bc65379d2a854d2cca843bd2eeb94f381e5a7dcae89e6ceb6ef4c58355`
`38`	`38`	`ENV GRADLE_HOME /usr/bin/gradle`
`39`	`39`
`40`	`40`	`RUN mkdir -p /usr/share/gradle /usr/share/gradle/ref \`
`41`		`- && echo "Downloading gradle" \`
	`41`	`+ && echo "Downloading Gradle" \`
`42`	`42`	`&& curl -fsSL -o /tmp/gradle.zip https://services.gradle.org/distributions/gradle-${GRADLE_VERSION}-bin.zip \`
`43`	`43`	`\`
`44`	`44`	`&& echo "Checking downloaded file hash" \`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ variable "step2_arch" {`
`32`	`32`	`description = "arch: What archicture is your Docker host on?"`
`33`	`33`	`validation {`
`34`	`34`	`condition = contains(["amd64", "arm64", "armv7"], var.step2_arch)`
`35`		`- error_message = "Value must be amd64, arm64 or armv7."`
	`35`	`+ error_message = "Value must be amd64, arm64, or armv7."`
`36`	`36`	`}`
`37`	`37`	`sensitive = true`
`38`	`38`	`}`
`@@ -54,20 +54,20 @@ resource "coder_agent" "dev" {`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`variable "docker_image" {`
`57`		`- description = "What docker image would you like to use for your workspace?"`
	`57`	`+ description = "What Docker imagewould you like to use for your workspace?"`
`58`	`58`	`default = "base"`
`59`	`59`
`60`	`60`	`# List of images available for the user to choose from.`
`61`	`61`	`# Delete this condition to give users free text input.`
`62`	`62`	`validation {`
`63`	`63`	`condition = contains(["base", "java", "node"], var.docker_image)`
`64`		`- error_message = "Invalid Docker Image!"`
	`64`	`+ error_message = "Invalid Docker image!"`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`# Prevents admin errors when the image is not found`
`68`	`68`	`validation {`
`69`	`69`	`condition = fileexists("images/${var.docker_image}.Dockerfile")`
`70`		`- error_message = "Invalid docker image. The file does not exist in the images directory."`
	`70`	`+ error_message = "Invalid Docker image. The file does not exist in the images directory."`
`71`	`71`	`}`
`72`	`72`	`}`
`73`	`73`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ variable "docker_image" {`
`66`	`66`	`default = "codercom/enterprise-base:ubuntu"`
`67`	`67`	`validation {`
`68`	`68`	`condition = contains(["codercom/enterprise-base:ubuntu", "codercom/enterprise-node:ubuntu", "codercom/enterprise-intellij:ubuntu"], var.docker_image)`
`69`		`- error_message = "Invalid Docker Image!"`
	`69`	`+ error_message = "Invalid Docker image!"`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`}`