You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/admin/templates/extending-templates/devcontainers.md
+13-11Lines changed: 13 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,13 @@ modules and configurations outlined in this doc.
9
9
10
10
## Why Use Dev Containers
11
11
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:
14
16
15
17
-**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.
17
19
-**Consistency across teams**: Everyone works in identical environments regardless of their local machine.
18
20
-**Version control**: Development environment changes are tracked alongside code changes.
19
21
@@ -55,7 +57,7 @@ RUN npm install -g @devcontainers/cli
55
57
56
58
## Define the Dev Container Resource
57
59
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`:
59
61
60
62
```terraform
61
63
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
69
71
70
72
This step is optional, but it ensures that the project is present before the dev container starts.
71
73
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:
0 commit comments