Skip to content

Commit acdbe4d

Browse files
Apply suggestions from code review
Co-authored-by: Mathias Fredriksson <mafredri@gmail.com>
1 parent cfcef3c commit acdbe4d

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

docs/admin/templates/extending-templates/devcontainers.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,13 @@ module "git_clone" {
9797
source = "dev.registry.coder.com/modules/git-clone/coder"
9898
agent_id = coder_agent.main.id
9999
url = "https://github.com/example/project.git"
100-
base_dir = "/home/coder/project"
100+
base_dir = "/home/coder"
101101
}
102102
103103
resource "coder_devcontainer" "project" {
104104
count = data.coder_workspace.me.start_count
105105
agent_id = coder_agent.main.id
106-
workspace_folder = "/home/coder/project/${module.git_clone[0].folder_name}"
106+
workspace_folder = "/home/coder/${module.git_clone[0].folder_name}"
107107
depends_on = [module.git_clone]
108108
}
109109
```
@@ -119,8 +119,9 @@ For more advanced use cases, consult the [advanced dev containers doc](./advance
119119
{
120120
"customizations": {
121121
"coder": {
122-
"apps": {
123-
"flask-app": {
122+
"apps": [
123+
{
124+
"slug": "flask-app",
124125
"command": "python app.py",
125126
"icon": "/icon/flask.svg",
126127
"subdomain": true,
@@ -130,7 +131,7 @@ For more advanced use cases, consult the [advanced dev containers doc](./advance
130131
"threshold": 10
131132
}
132133
}
133-
}
134+
]
134135
}
135136
}
136137
}
@@ -140,10 +141,10 @@ For more advanced use cases, consult the [advanced dev containers doc](./advance
140141

141142
Coder names dev container agents in this order:
142143

143-
1. `customizations.coder.agent.name` in `devcontainer.json`
144-
1. `name` in `devcontainer.json`
145-
1. Directory name that contains the config
146-
1. `devcontainer` (default)
144+
1. `customizations.coder.name` in `devcontainer.json`
145+
1. Resource name used in terraform (`resource "coder_devcontainer" "name"`)
146+
1. Project directory name (name of folder containing `devcontainer.json` or `.devcontainer` folder)
147+
1. If project directory name is already taken, the name is expanded to include the parent folder (`/home/coder/some/project` -> `project` (taken) -> `some-project`)
147148

148149
### Multiple dev containers
149150

docs/user-guides/devcontainers/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ When a workspace with the dev containers integration starts:
4040

4141
### Connectivity
4242

43-
- Full SSH access directly into dev containers (`coder ssh --container ...`).
44-
- Automatic port forwarding based on `appPort`, `forwardPorts`, or `docker-compose.yml`.
43+
- Full SSH access directly into dev containers (`coder ssh <workspace>.<devcontainer>`).
44+
- Automatic port forwarding.
4545

4646
## Personal overrides
4747

0 commit comments

Comments
 (0)