Skip to content

Commit 8f15caa

Browse files
mafredrimafredri
authored
docs: add dev container screenshots (#21191)
Add screenshots to the dev containers user guide: - Running dev containers with sub-agents (index.md, working-with-dev-containers.md) - Discovered dev containers with Start button (index.md) - Outdated status with rebuild option (working-with-dev-containers.md) - Display apps disabled (customizing-dev-containers.md) Also deletes the outdated devcontainer-agent-ports.png. Refs #21157
1 parent 84760f4 commit 8f15caa

File tree

8 files changed

+9
-1
lines changed

8 files changed

+9
-1
lines changed

‎docs/images/user-guides/devcontainers/devcontainer-agent-ports.png‎

-133 KB
Binary file not shown.

‎docs/images/user-guides/devcontainers/devcontainer-apps-bar.png‎

94.5 KB
Loading

‎docs/images/user-guides/devcontainers/devcontainer-discovery.png‎

107 KB
Loading

‎docs/images/user-guides/devcontainers/devcontainer-outdated.png‎

194 KB
Loading

‎docs/images/user-guides/devcontainers/devcontainer-running.png‎

187 KB
Loading

‎docs/user-guides/devcontainers/customizing-dev-containers.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ appears in `coder ssh` commands and the dashboard (e.g.,
8484
Control which built-in Coder apps appear for your dev container using
8585
`displayApps`:
8686

87+
![Dev container with all display apps disabled](../../images/user-guides/devcontainers/devcontainer-apps-bar.png)_Disable built-in apps to reduce clutter or guide developers toward preferred tools_
88+
8789
```json
8890
{
8991
"name": "My Dev Container",

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ administrators can configure
1111
[Envbuilder](../../admin/integrations/devcontainers/envbuilder/index.md) instead,
1212
which builds the workspace image itself from your dev container configuration.
1313

14+
![Two dev containers running as sub-agents in a Coder workspace](../../images/user-guides/devcontainers/devcontainer-running.png)_Dev containers appear as sub-agents with their own apps, SSH access, and port forwarding_
15+
1416
## Prerequisites
1517

1618
- Coder version 2.24.0 or later
@@ -67,6 +69,8 @@ Coder automatically discovers dev container configurations in your repositories
6769
and displays them in your workspace dashboard. From there, you can start a dev
6870
container with a single click.
6971

72+
![Discovered dev containers with Start buttons](../../images/user-guides/devcontainers/devcontainer-discovery.png)_Coder detects dev container configurations and displays them with a Start button_
73+
7074
If your template administrator has configured automatic startup (via the
7175
`coder_devcontainer` Terraform resource or autostart settings), your dev
7276
container will build and start automatically when the workspace starts.

‎docs/user-guides/devcontainers/working-with-dev-containers.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The dev container integration appears in your Coder dashboard, providing a
44
visual representation of the running environment:
55

6-
![Dev container integration in Coder dashboard](../../images/user-guides/devcontainers/devcontainer-agent-ports.png)
6+
![Two dev containers running as sub-agents in a Coder workspace](../../images/user-guides/devcontainers/devcontainer-running.png)_Dev containers appear as sub-agents with their own apps, SSH access, and port forwarding_
77

88
## SSH access
99

@@ -152,4 +152,6 @@ When you modify your `devcontainer.json`, you need to rebuild the container for
152152
changes to take effect. Coder detects changes and shows an **Outdated** status
153153
next to the dev container.
154154

155+
![Dev container showing Outdated status with rebuild option](../../images/user-guides/devcontainers/devcontainer-outdated.png)_The Outdated indicator appears when changes to devcontainer.json are detected_
156+
155157
Click **Rebuild** to recreate your dev container with the updated configuration.

0 commit comments

Comments
 (0)