Skip to content

Commit 11891da

Browse files
committed
consistency and words
1 parent 1af39a8 commit 11891da

File tree

2 files changed

+21
-20
lines changed

2 files changed

+21
-20
lines changed

docs/admin/templates/extending-templates/advanced-dev-containers.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Advanced Dev Container Configuration
22

3-
This page extends [devcontainers.md](./devcontainers.md) with patterns for multiple dev containers,
3+
This page extends the [devcontainers documentation](./devcontainers.md) with patterns for multiple dev containers,
44
user-controlled startup, repository selection, and infrastructure tuning.
55

66
## Run Multiple Dev Containers
@@ -11,7 +11,7 @@ In this example, there are two: `frontend` and `backend`:
1111

1212
```terraform
1313
# Clone each repo
14-
module "git_clone_frontend" {
14+
module "git-clone-frontend" {
1515
count = data.coder_workspace.me.start_count
1616
source = "dev.registry.coder.com/modules/git-clone/coder"
1717
@@ -20,7 +20,7 @@ module "git_clone_frontend" {
2020
base_dir = "/home/coder/frontend"
2121
}
2222
23-
module "git_clone_backend" {
23+
module "git-clone-backend" {
2424
count = data.coder_workspace.me.start_count
2525
source = "dev.registry.coder.com/modules/git-clone/coder"
2626
@@ -33,15 +33,14 @@ module "git_clone_backend" {
3333
resource "coder_devcontainer" "frontend" {
3434
count = data.coder_workspace.me.start_count
3535
agent_id = coder_agent.main.id
36-
workspace_folder = "/home/coder/frontend/${module.git_clone_frontend[0].folder_name}"
36+
workspace_folder = "/home/coder/frontend/${module.git-clone-frontend[0].folder_name}"
3737
}
3838
3939
resource "coder_devcontainer" "backend" {
4040
count = data.coder_workspace.me.start_count
4141
agent_id = coder_agent.main.id
42-
workspace_folder = "/home/coder/backend/${module.git_clone_backend[0].folder_name}"
42+
workspace_folder = "/home/coder/backend/${module.git-clone-backend[0].folder_name}"
4343
}
44-
4544
```
4645

4746
Each dev container appears as a separate agent, so developers can connect to any
@@ -64,7 +63,7 @@ data "coder_parameter" "enable_frontend" {
6463
resource "coder_devcontainer" "frontend" {
6564
count = data.coder_parameter.enable_frontend.value ? data.coder_workspace.me.start_count : 0
6665
agent_id = coder_agent.main.id
67-
workspace_folder = "/home/coder/frontend/${module.git_clone_frontend[0].folder_name}"
66+
workspace_folder = "/home/coder/frontend/${module.git-clone-frontend[0].folder_name}"
6867
}
6968
```
7069

@@ -92,10 +91,10 @@ Prompt users to pick a repository or team at workspace creation time and clone t
9291
}
9392
```
9493

95-
1. Change the `git_clone` module to accept the `value` as the `url`:
94+
1. Change the `git-clone` module to accept the `value` as the `url`:
9695

9796
```terraform
98-
module "git_clone" {
97+
module "git-clone" {
9998
count = data.coder_workspace.me.start_count
10099
source = "dev.registry.coder.com/modules/git-clone/coder"
101100
agent_id = coder_agent.main.id

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

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@ modules and configurations outlined in this doc.
99

1010
## Why Use Dev Containers
1111

12-
Dev containers improve consistency across environments by letting developers define their development setup.
13-
When integrated with Coder templates, they provide:
12+
Dev containers improve consistency across environments by letting developers define their development setup within
13+
the code repository.
14+
15+
When integrated with Coder templates, dev containers provide:
1416

1517
- **Project-specific environments**: Each repository can define its own tools, extensions, and configuration.
16-
- **Zero setup time**: Developers get fully configured environments without manual installation.
18+
- **Zero setup time**: Developers start workspace with fully configured environments without additional installation.
1719
- **Consistency across teams**: Everyone works in identical environments regardless of their local machine.
1820
- **Version control**: Development environment changes are tracked alongside code changes.
1921

@@ -55,7 +57,7 @@ RUN npm install -g @devcontainers/cli
5557

5658
## Define the Dev Container Resource
5759

58-
If you don't use [`git_clone`](#clone-the-repository), point the resource at the folder that contains `devcontainer.json`:
60+
If you don't use [`git-clone`](#clone-the-repository), point the resource at the folder that contains `devcontainer.json`:
5961

6062
```terraform
6163
resource "coder_devcontainer" "project" { # `project` in this example is how users will connect to the dev container: `ssh://project.<workspace>.me.coder`
@@ -69,11 +71,11 @@ resource "coder_devcontainer" "project" { # `project` in this example is how use
6971

7072
This step is optional, but it ensures that the project is present before the dev container starts.
7173

72-
Note that if you use the `git_clone` module, update or replace the `coder_devcontainer` resource
73-
to point to `/home/coder/project/${module.git_clone[0].folder_name}` so that it is only defined once:
74+
Note that if you use the `git-clone` module, update or replace the `coder_devcontainer` resource
75+
to point to `/home/coder/project/${module.git-clone[0].folder_name}` so that it is only defined once:
7476

7577
```terraform
76-
module "git_clone" {
78+
module "git-clone" {
7779
count = data.coder_workspace.me.start_count
7880
source = "dev.registry.coder.com/modules/git-clone/coder"
7981
agent_id = coder_agent.main.id
@@ -84,7 +86,7 @@ module "git_clone" {
8486
resource "coder_devcontainer" "project" {
8587
count = data.coder_workspace.me.start_count
8688
agent_id = coder_agent.main.id
87-
workspace_folder = "/home/coder/${module.git_clone[0].folder_name}"
89+
workspace_folder = "/home/coder/${module.git-clone[0].folder_name}"
8890
}
8991
```
9092

@@ -143,7 +145,7 @@ resource "coder_devcontainer" "backend" {
143145
}
144146
```
145147

146-
## Example Docker Dev Container
148+
## Example Docker Dev Container Template
147149

148150
<details><summary>Expand for the full file:</summary>
149151

@@ -173,7 +175,7 @@ module "devcontainers-cli" {
173175
agent_id = coder_agent.main.id
174176
}
175177
176-
module "git_clone" {
178+
module "git-clone" {
177179
count = data.coder_workspace.me.start_count
178180
source = "dev.registry.coder.com/modules/git-clone/coder"
179181
agent_id = coder_agent.main.id
@@ -184,7 +186,7 @@ module "git_clone" {
184186
resource "coder_devcontainer" "project" {
185187
count = data.coder_workspace.me.start_count
186188
agent_id = coder_agent.main.id
187-
workspace_folder = "/home/coder/${module.git_clone[0].folder_name}"
189+
workspace_folder = "/home/coder/${module.git-clone[0].folder_name}"
188190
}
189191
190192
resource "docker_container" "workspace" {

0 commit comments

Comments
 (0)