Skip to content

fix: minor fixes to templates docs #3117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 22, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions docs/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,13 @@ Terraform. There are two types of parameters:
values are often personalization settings such as "preferred region"
or "workspace image".

The template sample below uses *admin and user parameters* to allow developers to
The template sample below uses _admin and user parameters_ to allow developers to
create workspaces from any image as long as it is in the proper registry:

```hcl
variable "image_registry_url" {
description = "The image registry developers can sele"
default = "artifactory1.organization.com`
description = "The image registry developers can select"
default = "artifactory1.organization.com"
sensitive = true # admin (template-wide) parameter
}

Expand Down Expand Up @@ -188,7 +188,6 @@ resource "kubernetes_pod" "podName" {
}
```


#### Delete workspaces

When a workspace is deleted, the Coder server essentially runs a
Expand Down Expand Up @@ -256,8 +255,8 @@ practices:
- Ensure the resource has `curl` installed
- Ensure the resource can reach your Coder URL
- Manually connect to the resource (e.g., `docker exec` or AWS console)
- The Coder agent logs are typically stored in (`/var/log/coder-agent.log`)

- The Coder agent logs are typically stored in `/var/log/coder-agent.log`
- The Coder agent startup script logs are typically stored in `/var/log/coder-startup-script.log`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should just say stored, not typically

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about Windows @kylecarbs?


## Change Management

Expand Down