docs(elsa): getting started
This commit is contained in:
parent
d1c11aff89
commit
b5a9db8693
33
elsa/getting-started.md
Normal file
33
elsa/getting-started.md
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
# Getting started
|
||||
|
||||
The Elsa workflows engine is already wired into the app — there is nothing to
|
||||
install. Open the **Elsa Flows** page from the main menu.
|
||||
|
||||
## Create a definition
|
||||
|
||||
1. On **Elsa Flows**, click **New**.
|
||||
2. Pick a root template (empty or a starter graph).
|
||||
3. Give the workflow a name and save.
|
||||
|
||||
The definition list on `/flows` shows one row per definition (the latest
|
||||
version). Use the version filter in the list header to switch between
|
||||
*Latest*, *Published*, *Draft* and *All versions*.
|
||||
|
||||
## Run it
|
||||
|
||||
Select a definition and press **Run** in the toolbar. A new run opens on the
|
||||
**Runs** page (`/flows/runs`), where you can follow the incident list, the
|
||||
journal and the execution call stack.
|
||||
|
||||
<div class="docs-note">
|
||||
A definition must be <strong>published</strong> before the engine can execute it.
|
||||
Running a draft returns the engine's <em>published version not found</em> error.
|
||||
</div>
|
||||
|
||||
```json
|
||||
{
|
||||
"definitionId": "hello-world",
|
||||
"version": "1.0.0",
|
||||
"isPublished": true
|
||||
}
|
||||
```
|
||||
Loading…
Reference in a new issue