[Feature]: Add medium priority documentation for Workflow Best Practices

[srichmond]

Contact Details

srichmond@es.net

What should we build?

Please create reference documentation for the following topics on https://workfloworchestrator.org/orchestrator-core/ using the instructions in https://workfloworchestrator.org/orchestrator-core/contributing/development/#adding-to-the-documentation

• 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 idempotent
• 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

[pboers1988]

https://workfloworchestrator.org/orchestrator-core/architecture/application/workflow/#default-workflows

[hanstrompert]

Quite some of these BCP are also already covered, more or less, in https://github.com/workfloworchestrator/example-orchestrator/blob/master/README.md.

[hanstrompert]

Add the suggested BCP to architecture/application/workflow.md.

Merge the Best Practices section from workshops/advanced/workflow-introduction.md to this BCP and replace with a reference.