orchestrator-core
orchestrator-core copied to clipboard
[Feature]: Add medium priority documentation for Workflow Lifecycle transitioning
Contact Details
What should we build?
Please create reference documentation for the following topics on https://workfloworchestrator.org/orchestrator-core/ using the "how to write docs" information located in https://docs.google.com/document/d/10Fz98moy-pMyyk__PTR8xg4aeHuIv5VegJa99ZpzvkI/edit
- [ ] BCP in workflows: Example of “Reusable” step pattern (fn that returns step)
- [ ] BCP in workflows: No commits allowed inside a step: Commit is disabled on the ORM (This is disabled in the orch-core)
- [ ] BCP in workflows: Steps are Retryable - should be an atomic unit
- [ ] BCP in workflows: One create workflow per product
- [ ] BCP in workflows: Many modify workflows (But maybe “few”?)
- [ ] BCP in workflows: One terminate
- [ ] BCP in workflows: One validate
- [ ] BCP in workflows: Single-dispatch pattern
- [ ] Workflows are an audittrail, not a transporter of data
- [ ] Workflow lifecyclemapping: Constrain workflow usage per lifecycle WF_USABLE_MAPPING
Relevant pseudo code
No response
https://workfloworchestrator.org/orchestrator-core/architecture/application/workflow/#default-workflows
Quite some of these BCP are also already covered, more or less, in https://github.com/workfloworchestrator/example-orchestrator/blob/master/README.md.