<a id="ref-workshop-status"></a>

# Workshop status diagrams

<!-- @artefact workshop status -->
<!-- @artefact project -->

During its lifecycle, a workshop goes through a number of states,
which we call *statuses* to distinguish them from SDK states.
The following partial diagrams represent each state
with the commands that cause the workshop to transition to a different status.

## Off

Always the starting point,
where the workshop exists solely as a
[definition file](https://ubuntu.com/workshop/docs//reference/definition-files/workshop-definition.md#ref-workshop-definition)
in the project directory;
there is no container yet.

## Ready

The workshop was successfully launched from the definition file;
its underlying container is linked to the project directory,
up and ready to do some work.

## Stopped

The underlying container was stopped
but is still linked to the project directory.

## Waiting

The workshop is paused
in the middle of a change
to allow for interactive debugging;
only a few commands will be accepted.

## Pending

An intermediate state
while the workshop is being updated or changing its status;
only a few commands will be accepted.

## Error

The workshop failed at some stage,
and its underlying container became nonoperational.

## See also

Explanation:

- [Workshop status](https://ubuntu.com/workshop/docs//explanation/workshops/concepts.md#exp-workshop-status)

Reference:

- [Command-line interfaces](https://ubuntu.com/workshop/docs//reference/index.md#ref-cli)