fmt

bpmct · bpmct · commit 72caf68b061e · 2023-09-26T21:02:33.000Z
diff --git a/examples/templates/do-linux/README.md b/examples/templates/do-linux/README.md
@@ -6,6 +6,7 @@ maintainer_github: coder
 verified: true
 tags: [vm, linux, digitalocean]
 ---
+
 # Remote Development on DigitalOcean Droplets
 
 Provision DigitalOcean Droplets as [Coder workspaces](https://coder.com/docs/coder-v2/latest) with this example template.
@@ -19,7 +20,7 @@ To deploy workspaces as DigitalOcean Droplets, you'll need:
 - DigitalOcean [personal access token (PAT)](https://docs.digitalocean.com/reference/api/create-personal-access-token/)
 
 - DigitalOcean project ID (you can get your project information via the `doctl`
-CLI by running `doctl projects list`)
+  CLI by running `doctl projects list`)
 
 - Remove the following sections from the `main.tf` file if you don't want to
   associate your workspaces with a project:
@@ -28,7 +29,7 @@ CLI by running `doctl projects list`)
   - `resource "digitalocean_project_resources" "project"`
 
 - **Optional:** DigitalOcean SSH key ID (obtain via the `doctl` CLI by running
-`doctl compute ssh-key list`)
+  `doctl compute ssh-key list`)
 
 - Note that this is only required for Fedora images to work.
 
diff --git a/examples/templates/gcp-linux/README.md b/examples/templates/gcp-linux/README.md
@@ -56,6 +56,7 @@ Coder persists the root volume. The full filesystem is preserved when the worksp
 
 > **Note**
 > This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
+
 ## code-server
 
 `code-server` is installed via the `startup_script` argument in the `coder_agent`
diff --git a/examples/templates/gcp-windows/README.md b/examples/templates/gcp-windows/README.md
@@ -56,6 +56,7 @@ Coder persists the root volume. The full filesystem is preserved when the worksp
 
 > **Note**
 > This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
+
 ## code-server
 
 `code-server` is installed via the `startup_script` argument in the `coder_agent`
diff --git a/examples/templates/nomad-docker/README.md b/examples/templates/nomad-docker/README.md
@@ -7,6 +7,36 @@ verified: true
 tags: [nomad, container]
 ---
 
+# Remote Development on Nomad
+
+Provision Nomad Jobs as [Coder workspaces](https://coder.com/docs/coder-v2/latest) with this example template.
+
+<!-- TODO: Add screenshot -->
+
+## Prerequisites
+
+### Infrastructure
+
+**Cluster**: This template requires an existing Kubernetes cluster
+
+**Container Image**: This template uses the [codercom/enterprise-base:ubuntu image](https://github.com/coder/enterprise-images/tree/main/images/base) with some dev tools preinstalled. To add additional tools, extend this image or build it yourself.
+
+### Authentication
+
+This template authenticates using a `~/.kube/config`, if present on the server, or via built-in authentication if the Coder provisioner is running on Kubernetes with an authorized ServiceAccount. To use another [authentication method](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs#authentication), edit the template.
+
+## Architecture
+
+This template provisions the following resources:
+
+- Kubernetes pod (ephemeral)
+- Kubernetes persistent volume claim (persistent on `/home/coder`)
+
+This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles.
+
+> **Note**
+> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
+
 # Develop in a Nomad Docker Container
 
 This example shows how to use Nomad service tasks to be used as a development environment using docker and host csi volumes.
