docs: clean up English

ammario · ammario · commit 9755f5a175e9 · 2022-07-31T19:38:38.000Z
Some minor mistakes were introduced in #3319
diff --git a/docs/templates.md b/docs/templates.md
@@ -98,11 +98,7 @@ inherited by all child processes of the agent, including SSH sessions.
 #### startup_script
 
 Use the Coder agent's `startup_script` to run additional commands like
-installing IDEs and clone dotfile and project repos. In this example, the
-project and dotfile repos are specified as Terraform input variables elsewhere
-in the `main.tf` Note the `&` after the `code-server` start to execute
-`code-server` process in the background so the `startup_script` can continue
-with the repo cloning steps.
+installing IDEs, [cloning dotfile](./dotfiles.md#templates), and cloning project repos.
 
 ```hcl
 resource "coder_agent" "coder" {
@@ -113,27 +109,27 @@ resource "coder_agent" "coder" {
 #!/bin/bash
 
 # install code-server
-curl -fsSL https://code-server.dev/install.sh | sh 
+curl -fsSL https://code-server.dev/install.sh | sh
+
+# The & prevents the startup_script from blocking so the
+# next commands can run.
 code-server --auth none --port &
 
+# var.repo and var.dotfiles_uri is specified
+# elsewhere in the Terraform code as input
+# variables.
+
 # clone repo
 ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts
 git clone --progress git@github.com:${var.repo}
 
 # use coder CLI to clone and install dotfiles
 coder dotfiles -y ${var.dotfiles_uri}
 
-  EOT  
+  EOT
 }
 ```
 
-#### Logging
-
-The output of the `startup_script` are located in
-`/tmp/coder-startup-script.log` within the workspace.
-
-The Coder agent log is located in `/tmp/coder-agent.log` within the workspace.
-
 ### Parameters
 
 Templates often contain _parameters_. These are defined by `variable` blocks in
diff --git a/docs/workspaces.md b/docs/workspaces.md
@@ -49,6 +49,15 @@ The workspace will be stopped and started:
 coder update <workspace-name>
 ```
 
+## Logging
+
+Coder stores MacOS and Linux logs at the following locations:
+
+| Service          | Location                        |
+| ---------------- | ------------------------------- |
+| `startup_script` | `/tmp/coder-startup-script.log` |
+| Agent            | `/tmp/coder-agent.log`          |
+
 ---
 
 ## Up next
