Skip to content

docs: clean up English #3324

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.

Sign up for GitHub

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 2 commits into from
Jul 31, 2022
Merged

docs: clean up English #3324

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9755f5a
docs: clean up English
ammario Jul 31, 2022
8fea7d5
Fix issues in #3320
ammario Jul 31, 2022
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
Next Next commit
docs: clean up English 
Some minor mistakes were introduced in #3319
  • Loading branch information
@ammario
ammario committed Jul 31, 2022
commit 9755f5a175e983a86fc7c17fd14bedc3f8c243f4
24 changes: 10 additions & 14 deletions docs/templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" {
Expand All @@ -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
Expand Down
9 changes: 9 additions & 0 deletions docs/workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down