Skip to content

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

@srichmond

Description

@srichmond

Contact Details

[email protected]

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions