Skip to content

Add components overview #810

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

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Add components overview #810

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
83dc168
Add components overview
Granjow Apr 14, 2021
409df99
Merge into getting started
Granjow Apr 26, 2021
d420865
Add summaries to interface
Granjow Jun 9, 2021
c850973
Updates according to MR review
Granjow Jun 9, 2021
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
12 changes: 11 additions & 1 deletion docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Each running workflow is persisted to the chosen persistence provider between ea

## Host

The workflow host is the service responsible for executing workflows. It does this by polling the persistence provider for workflow instances that are ready to run, executes them and then passes them back to the persistence provider to by stored for the next time they are run. It is also responsible for publishing events to any workflows that may be waiting on one.
The workflow host is the service responsible for executing workflows. It does this by polling the persistence provider for workflow instances that are ready to run, executes them and then passes them back to the persistence provider to be stored for the next time they are run. It is also responsible for publishing events to any workflows that may be waiting on one.

### Setup

Expand All @@ -114,6 +114,16 @@ Console.ReadLine();
host.Stop();
```

## Registry

The workflow host keeps workflow definitions in the registry when they are registered. When starting a workflow, the workflow host creates a new instance for the desired workflow definition.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The workflow host does not keep the definitions, the registry does, the workflow host accesses the registry.



## Persistence

The persistence provider persists the state of a workflow instance with execution pointers. They are created when visiting a step while executing a workflow and hold information about their outcome.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think execution pointers are more of an internal concept, not really specific to persistence?
Either way, I'm not sure this paragraph gives a description of what they are.



## Passing data between steps

Each step is intended to be a black-box, therefore they support inputs and outputs. These inputs and outputs can be mapped to a data class that defines the custom data relevant to each workflow instance.
Expand Down