Skip to content

Commit d3fd3b8

Browse files
EdwardAngertEdwardAngert
committed
edits from code review
1 parent 1deae60 commit d3fd3b8

File tree

4 files changed

+1
-53
lines changed

4 files changed

+1
-53
lines changed

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

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -67,24 +67,6 @@ resource "coder_devcontainer" "database" {
6767
Each dev container appears as a separate agent, so developers can connect to any
6868
component in the workspace.
6969

70-
## Personal Overrides
71-
72-
Let developers extend the repo’s `devcontainer.json` with an ignored (by Git) `devcontainer.local.json` file
73-
so they can add personal tools without changing the canonical configuration:
74-
75-
```jsonc
76-
{
77-
"extends": "./devcontainer.json",
78-
"features": {
79-
"ghcr.io/devcontainers/features/node": { "version": "20" }
80-
},
81-
"postStartCommand": "npm i -g tldr"
82-
}
83-
```
84-
85-
Add the file name to your project's `.gitignore` or the user's
86-
[global exclude file](https://docs.github.com/en/get-started/git-basics/ignoring-files#configuring-ignored-files-for-all-repositories-on-your-computer).
87-
8870
## Conditional Startup
8971

9072
Use `coder_parameter` booleans to let workspace creators choose which dev containers start automatically,

‎docs/admin/templates/extending-templates/dev-containers-envbuilder.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Use this page to decide which path fits your project or platform needs.
1616
| Multiple Dev Containers per workspace | Yes | No |
1717
| Rebuild when `devcontainer.json` changes | Yes (auto-prompt) | Limited (requires full workspace rebuild) |
1818
| Docker required in workspace | Yes | No (works in restricted envs) |
19-
| Admin vs. developer control | Developer decides per repo | Platform admin manages via template |
2019
| Templates | Standard `devcontainer.json` | Terraform + Envbuilder blocks |
2120
| Suitable for CI / AI agents | Yes. Deterministic, composable | Less ideal. No isolated container |
2221

‎docs/admin/templates/managing-templates/devcontainers/index.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,7 @@ For the Docker-based Dev Containers integration, follow the [Configure a templat
2323
An administrator should construct or choose a base image and create a template
2424
that includes an Envbuilder container image `coder/envbuilder` before a developer team configures dev containers.
2525

26-
## Benefits of Envbuilder
27-
28-
Key differences compared with the [Docker-based integration](../../extending-templates/devcontainers.md):
29-
30-
| Capability / Trait | Dev Containers integration (CLI-based) | Envbuilder Dev Containers |
31-
|------------------------------------------|------------------------------------------|-------------------------------------------|
32-
| Build engine | `@devcontainers/cli` + Docker | Envbuilder transforms the workspace image |
33-
| Runs separate Docker container | Yes (parent workspace + child container) | No (modifies the parent container) |
34-
| Multiple Dev Containers per workspace | Yes | No |
35-
| Rebuild when `devcontainer.json` changes | Yes (auto-prompt) | Limited (requires full workspace rebuild) |
36-
| Docker required in workspace | Yes | No (works in restricted envs) |
37-
| Admin vs. developer control | Developer decides per repo | Platform admin manages via template |
38-
| Templates | Standard `devcontainer.json` | Terraform + Envbuilder blocks |
39-
| Suitable for CI / AI agents | Yes. Deterministic, composable | Less ideal. No isolated container |
40-
41-
Consult the full comparison at [Choose an approach to Dev Containers](../../extending-templates/dev-containers-envbuilder.md).
26+
Compare the differences between [Envbuilder and the Dev Containers integration](../../extending-templates/dev-containers-envbuilder.md).
4227

4328
## Dev container Features
4429

‎docs/user-guides/devcontainers/index.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -43,24 +43,6 @@ When a workspace with the dev containers integration starts:
4343
- Full SSH access directly into dev containers (`coder ssh <workspace>.<devcontainer>`).
4444
- Automatic port forwarding.
4545

46-
## Personal overrides
47-
48-
To add tools or tweaks that enhance your personal experience, create a `devcontainer.local.json` file in the same
49-
directory as the project’s `devcontainer.json`:
50-
51-
```jsonc
52-
{
53-
"extends": "./devcontainer.json",
54-
"features": {
55-
"ghcr.io/devcontainers/features/node": { "version": "20" }
56-
},
57-
"postStartCommand": "npm i -g tldr"
58-
}
59-
```
60-
61-
Add the file name to your project's `.gitignore` or to your
62-
[global exclude file](https://docs.github.com/en/get-started/git-basics/ignoring-files#configuring-ignored-files-for-all-repositories-on-your-computer).
63-
6446
## Comparison with Envbuilder-based Dev Containers
6547

6648
| Feature | Dev Containers | Envbuilder Dev Containers |

0 commit comments

Comments
 (0)