Skip to content

Commit bf9ca78

Browse files
mafredrimafredri
committed
docs(docs/user-guides/devcontainers): add screenshot placeholders
Add placeholder images to show what dev containers look like in the UI: - Workspace dashboard with discovered dev container (index.md) - Apps bar on dev container agent (customizing-dev-containers.md) - Outdated status with Rebuild button (working-with-dev-containers.md) Refs #21157
1 parent 779f157 commit bf9ca78

File tree

8 files changed

+17
-1
lines changed

8 files changed

+17
-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‎

Loading

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

Loading

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

Loading

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

Loading

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,10 @@ 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+
![Placeholder: Dev container agent showing apps bar with terminal, VS Code, SSH helper, and port forwarding buttons](../../images/user-guides/devcontainers/devcontainer-apps-bar.png)
88+
89+
<small>The apps bar on a dev container agent, showing the available display apps.</small>
90+
8791
```json
8892
{
8993
"name": "My Dev Container",

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ 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+
![Placeholder: Running dev container showing the sub-agent with terminal, ports, and IDE options](../../images/user-guides/devcontainers/devcontainer-running.png)
15+
16+
<small>A running dev container appears as a sub-agent in your workspace with full access to terminal, ports, and IDE integrations.</small>
17+
1418
## Prerequisites
1519

1620
- Coder version 2.24.0 or later
@@ -67,6 +71,10 @@ Coder automatically discovers dev container configurations in your repositories
6771
and displays them in your workspace dashboard. From there, you can start a dev
6872
container with a single click.
6973

74+
![Placeholder: Workspace dashboard showing a discovered dev container with status indicator and Start button](../../images/user-guides/devcontainers/devcontainer-discovery.png)
75+
76+
<small>Dev container displayed in the workspace dashboard with status and action buttons.</small>
77+
7078
If your template administrator has configured automatic startup (via the
7179
`coder_devcontainer` Terraform resource or autostart settings), your dev
7280
container will build and start automatically when the workspace starts.

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

Lines changed: 5 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+
![Placeholder: Running dev container showing the sub-agent with terminal, ports, and IDE options](../../images/user-guides/devcontainers/devcontainer-running.png)
77

88
## SSH access
99

@@ -152,4 +152,8 @@ 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+
![Placeholder: Dev container agent showing the Outdated status indicator](../../images/user-guides/devcontainers/devcontainer-outdated.png)
156+
157+
<small>The Outdated indicator appears when changes to devcontainer.json are detected.</small>
158+
155159
Click **Rebuild** to recreate your dev container with the updated configuration.

0 commit comments

Comments
 (0)