Draft
Conversation
Owner
danielgerlag
left a comment
danielgerlag
left a comment
There was a problem hiding this comment.
Is the target audience consumers of workflow core or contributors to the library itself?
docs/getting-started.md
Outdated
|
|
||
| ## 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. |
Owner
There was a problem hiding this comment.
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.
docs/getting-started.md
Outdated
|
|
||
| ## 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. |
Owner
There was a problem hiding this comment.
The workflow host does not keep the definitions, the registry does, the workflow host accesses the registry.
Contributor
Author
|
@danielgerlag Thanks for your review, I have updated the pull request. Better now? Target audience is mainly consumers of the library, but I have found it easier to work with Workflow Core when also understanding some of the more internal concepts. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This documentation PR adds a short overview over some main components which are available in Workflow Core. Having a bigger picture or architecture view was something I missed when starting with Workflow Core.
I'd prefer something like a C4 components diagram, but readthedocs seems to be limited with diagram options.
Any suggestions/ideas?