NotificationsYou must be signed in to change notification settings
Fork947
Star10.5k

docs: update dev container docs for GA#18907

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Draft

EdwardAngert wants to merge16 commits intomain

base:main

Choose a base branch

from18582-dev-containers

Draft

docs: update dev container docs for GA#18907

EdwardAngert wants to merge16 commits intomainfrom18582-dev-containers

+423 −239

Conversation

Copy link

Contributor

EdwardAngert commentedJul 16, 2025•
edited
Loading

WIP

update dev container docs for GA

followup to#18582

To do

editdocs/user-guides/devcontainers/working-with-dev-containers.md
- current doc's approach is for pre-ga
- does it still need ssh/web terminal/VS Code sections?
- does it still need the Port Forwarding section?
- Dev Container Features can be both about features of dev containers ordev container features and the latter is now part of the main repo
docs where we use the git clone module
- it's technically optional, but more likely that not-using it would be the exception, so we should probably default to configurations that treat it as a default (like usingrepo_dir)
address / move comments from 18582
(placeholder)

EdwardAngert added13 commits

July 15, 2025 20:51

update devcontainers for ga

fb92c9f

edit devcontainers doc

5a4ca2f

add advanced dev containers

d978111

add dev-container-envbuilder comparison

736202d

edit add-devcontainer

09effa1

edit dev-container-known-issues

0b4ac18

edit envbuilder docs

bff7a37

update workspace screenshot

dde4010

update workspace screenshot

02b110f

update manifest

0f47c56

update user-guide

0e8383e

troubleshooting-dev-containers

4116768

init working-with-dev-containers edit

6a6a49e

EdwardAngert self-assigned this

Jul 16, 2025

EdwardAngert added the docsArea: coder.com/docs label

Jul 16, 2025

github-actionsbot reviewed

Jul 16, 2025

View reviewed changes

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

		[`coder_devcontainer`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/devcontainer)
		resource automatically starts a dev container in your workspace, ensuring it's
		ready when you access the workspace:
		If you don't use the [`git-clone`](#clone-the-repository) module, point the resource at the folder that contains `devcontainer.json`:

Copy link

github-actionsbotJul 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

🚫[linkspector]_{reported byreviewdog 🐶}
Cannot reach #clone-the-repository Status: 404 Cannot find section: #clone-the-repository in file: docs/admin/templates/extending-templates/devcontainers.md.

dev container casing

7a4719d

github-actionsbot reviewed

Jul 17, 2025

View reviewed changes

docs/about/contributing/backend.md

		@@ -49,7 +49,7 @@ Coder's backend is built using a collection of robust, modern Go libraries and i

		The Coder backend is organized into multiple packages and directories, each with a specific purpose. Here's a high-level overview of the most important ones:

		* [agent](https://github.com/coder/coder/tree/main/agent): core logic of a workspace agent, supportsDevContainers, remote SSH, startup/shutdown script execution. Protobuf definitions for DRPC communication with `coderd` are kept in [proto](https://github.com/coder/coder/tree/main/agent/proto).
		* [agent](https://github.com/coder/coder/tree/main/agent): core logic of a workspace agent, supportsdev containers, remote SSH, startup/shutdown script execution. Protobuf definitions for DRPC communication with `coderd` are kept in [proto](https://github.com/coder/coder/tree/main/agent/proto).
		* [cli](https://github.com/coder/coder/tree/main/cli): CLI interface for `coder` command built on [coder/serpent](https://github.com/coder/serpent). Input controls are defined in [cliui](https://github.com/coder/coder/tree/docs-backend-contrib-guide/cli/cliui), and [testdata](https://github.com/coder/coder/tree/docs-backend-contrib-guide/cli/testdata) contains golden files for common CLI calls

Copy link

github-actionsbotJul 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

🚫[linkspector]_{reported byreviewdog 🐶}
Cannot reachhttps://github.com/coder/coder/tree/docs-backend-contrib-guide/cli/cliui Status: 404

docs/about/contributing/backend.md

		@@ -49,7 +49,7 @@

		The Coder backend is organized into multiple packages and directories, each with a specific purpose. Here's a high-level overview of the most important ones:

		* [agent](https://github.com/coder/coder/tree/main/agent): core logic of a workspace agent, supportsDevContainers, remote SSH, startup/shutdown script execution. Protobuf definitions for DRPC communication with `coderd` are kept in [proto](https://github.com/coder/coder/tree/main/agent/proto).
		* [agent](https://github.com/coder/coder/tree/main/agent): core logic of a workspace agent, supportsdev containers, remote SSH, startup/shutdown script execution. Protobuf definitions for DRPC communication with `coderd` are kept in [proto](https://github.com/coder/coder/tree/main/agent/proto).
		* [cli](https://github.com/coder/coder/tree/main/cli): CLI interface for `coder` command built on [coder/serpent](https://github.com/coder/serpent). Input controls are defined in [cliui](https://github.com/coder/coder/tree/docs-backend-contrib-guide/cli/cliui), and [testdata](https://github.com/coder/coder/tree/docs-backend-contrib-guide/cli/testdata) contains golden files for common CLI calls

Copy link

github-actionsbotJul 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

🚫[linkspector]_{reported byreviewdog 🐶}
Cannot reachhttps://github.com/coder/coder/tree/docs-backend-contrib-guide/cli/testdata Status: 404

EdwardAngert added2 commits

July 17, 2025 19:41

link fix

f88ecb8

s/coder ssh/ssh

5085d78

EdwardAngert commented

Jul 17, 2025

View reviewed changes

docs/user-guides/devcontainers/index.md

		- SSH access requires using the `--container` flag
		- Some devcontainer features may not work as expected
		```shell
		ssh <agent>.<workspace>.me.coder

Copy link

ContributorAuthor

EdwardAngertJul 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I couldn't get it working withcoder ssh, but it worked like this

Labels

docs

Area: coder.com/docs

1 participant

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: update dev container docs for GA#18907

Are you sure you want to change the base?

docs: update dev container docs for GA#18907

Conversation

EdwardAngert commentedJul 16, 2025•
edited
Loading

Uh oh!

To do

Uh oh!

github-actionsbotJul 16, 2025

Choose a reason for hiding this comment

Uh oh!

github-actionsbotJul 17, 2025

Choose a reason for hiding this comment

Uh oh!

github-actionsbotJul 17, 2025

Choose a reason for hiding this comment

Uh oh!

EdwardAngertJul 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Movatterモバイル変換

docs: update dev container docs for GA#18907

Are you sure you want to change the base?

docs: update dev container docs for GA#18907

Conversation

EdwardAngert commentedJul 16, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

To do

Uh oh!

github-actionsbotJul 16, 2025

Choose a reason for hiding this comment

Uh oh!

github-actionsbotJul 17, 2025

Choose a reason for hiding this comment

Uh oh!

github-actionsbotJul 17, 2025

Choose a reason for hiding this comment

Uh oh!

EdwardAngertJul 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

EdwardAngert commentedJul 16, 2025•
edited
Loading