Skip to content

chore: add status information to workspaces #443

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 7, 2021
Merged

chore: add status information to workspaces #443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added assets/workspaces/status-chip.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/workspaces/workspace-overview.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 24 additions & 3 deletions workspaces/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,30 @@ Coder redirects you to an overview page for your workspace during the build
process. Learn more about the workspace
[creation parameters](./workspace-params.md).

Your workspace persists in the home directory, updates to new versions of the
image, and runs custom configuration on startup. Learn about the
[workspace lifecycle](lifecycle.md).
![Workspace overview](../assets/workspaces/workspace-overview.png)

Your workspace persists in the home directory, updates itself to new versions of
the image on which it is built, and runs custom configuration on startup. Learn
about the [workspace lifecycle](lifecycle.md).

### Workspace status

The workspace overview page displays information regarding the status and
performance of your workspace.

![Workspace overview](../assets/workspaces/status-chip.png)

The following workspace statuses are available:

- **Running**: Your workspace is running
- **Off**: Your workspace has been shut off either manually or due to inactivity
- **Error**: An unknown error has occurred
- **Building**: Your workspace is building
- **Turning off**: Your workspace is turning off
- **Unknown**: Your workspace is in an unknown state
- **Initializing**: The container is initializing
- **Decommissioned**: Your workspace is being deleted, and compute resources are
being released.

### Advanced

Expand Down