Skip to content
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.

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

Notes on first time working with the package #22

Open
SebastianKapunkt opened this issue Oct 21, 2020 · 1 comment
Open

Notes on first time working with the package #22

SebastianKapunkt opened this issue Oct 21, 2020 · 1 comment
Assignees
Labels
docs Documentation enhancements or errors

Comments

@SebastianKapunkt
Copy link
Contributor

1) Workflow & State

For me the separation between a workflow and state is not quite obvious in the first place.
Also, that a state is actually a new model is not obvious. (In the Tutorial it is not clear why the flow or the state needs a User)

2) Entry point of a Task

In the tutorial the start edge is defined as variable on the workflow. But it is unclear what all kinds of implications this has. Once you have reached all parts connected to the start edge it gets more clear.

3) Workflow creation

For me, it took some time to understand that for any workflow you want to create, you actually have to create an object. At first glance it could be like an add-on where you hook up to the model itself and just add tasks. But now I understand that each workflow needs a model representation (and that it can be an existing model). And that migrations are needed.

For a bit more complicated use cases or integration with an existing model it would be nice to have some documentation.

All in all it is a really nice package and well-thought-out.

@codingjoe
Copy link
Owner

Hi @SebastianKapunkt,

I did simplify the readme and tutorial to address your first point. I am not so sure though, how to go about the other two points. Maybe you have suggestion on how to address those problems?

Best,
Joe

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation enhancements or errors
Projects
None yet
Development

No branches or pull requests

2 participants