Skip to content

Commit 0b5cd24

Browse files
committed
don't encourage envbuilder
1 parent 11891da commit 0b5cd24

File tree

4 files changed

+8
-16
lines changed

4 files changed

+8
-16
lines changed

docs/admin/templates/managing-templates/devcontainers/add-devcontainer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ This allows the template to prompt for the developer for their dev container rep
66
[parameter](../../extending-templates/parameters.md) when they create their workspace.
77
Envbuilder clones the repo and builds a container from the `devcontainer.json` specified in the repo.
88

9+
This is a legacy implementation.
10+
911
For the Docker-based Dev Containers integration, follow the [Configure a template for dev containers](../../extending-templates/devcontainers.md) documentation instead.
1012

1113
You can create template files through the Coder dashboard, CLI, or you can choose a template from the

docs/admin/templates/managing-templates/devcontainers/devcontainer-releases-known-issues.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Envbuilder Dev Container Releases and Known Issues
22

3+
Envbuilder is a legacy implementation of dev containers.
4+
5+
For the Docker-based Dev Containers integration, follow the [Configure a template for dev containers](../../extending-templates/devcontainers.md) documentation instead.
6+
37
## Release Channels
48

59
Envbuilder provides two release channels:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ pre-approved by platform teams in registries like
1414
workflows, reduces the need for tickets and approvals, and promotes greater
1515
independence for developers.
1616

17-
This doc explains how to use Envbuilder to integrate dev containers in a template.
17+
Envbuilder is a legacy implementation of dev containers.
1818

19-
For the Docker-based Dev Containers integration, follow the [Configure a template for dev containers](../../extending-templates/devcontainers.md) documentation.
19+
For the Docker-based Dev Containers integration, follow the [Configure a template for dev containers](../../extending-templates/devcontainers.md) documentation instead.
2020

2121
## Prerequisites
2222

docs/user-guides/devcontainers/index.md

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

46-
## Comparison with Envbuilder-based Dev Containers
47-
48-
| Feature | Dev Containers | Envbuilder Dev Containers |
49-
|----------------|----------------------------------------|----------------------------------------------|
50-
| Implementation | Direct `@devcontainers/cli` and Docker | Coder's Envbuilder |
51-
| Target users | Individual developers | Platform teams and administrators |
52-
| Configuration | Standard `devcontainer.json` | Terraform templates with Envbuilder |
53-
| Management | User-controlled | Admin-controlled |
54-
| Requirements | Docker access in workspace | Compatible with more restricted environments |
55-
56-
Choose the appropriate solution based on your team's needs and infrastructure constraints.
57-
58-
Visit [Choose an approach to Dev Containers](../../admin/templates/extending-templates/dev-containers-envbuilder.md) for a more in-depth comparison.
59-
6046
## Known Limitations
6147

6248
Currently, dev containers are not compatible with [prebuilt workspaces](../../admin/templates/extending-templates/prebuilt-workspaces.md).

0 commit comments

Comments
 (0)