Concepts

Concepts#

This part of the documentation explains why the package works the way it does. It is discursive rather than instructional; for directions toward a result, see How-to guides.

Workflow chains

What a chain is, why chains were impractical before, and what this package changes.

About workflow chains
Behavior-driven assignment

Why workflows are assigned through behaviors, and how the chain adapter applies to participating content alone.

About behavior-driven assignment
State variables

Why review_state belongs to the publication workflow, and why additional workflows share one other name.

About state variables and review_state
Permissions

The one constraint concurrent workflows must satisfy, and why an overlap is reported rather than resolved.

About permissions in a chain
The workflow_states index

Why one catalog index describes a whole chain, and why existing review_state queries are rewritten onto it.

About the workflow_states index
Scope

What the package deliberately does not do.

About the scope of this package

See also

The Diátaxis framework calls this class of documentation explanation.