Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ strategy for building Low-Code applications.

## Build status
[![SpiffWorkflow](https://github.com/sartography/SpiffWorkflow/actions/workflows/tests.yaml/badge.svg)](https://github.com/sartography/SpiffWorkflow/actions/workflows/tests.yaml)
[![Documentation Status](https://readthedocs.org/projects/spiffworkflow/badge/?version=latest)](http://spiffworkflow.readthedocs.io/en/latest/?badge=latest)
[![Documentation](https://img.shields.io/badge/docs-spiff.works-blue)](https://spiff.works/docs/spiffworkflow/)
[![Issues](https://img.shields.io/github/issues/sartography/spiffworkflow)](https://github.com/sartography/SpiffWorkflow/issues)
[![Pull Requests](https://img.shields.io/github/issues-pr/sartography/spiffworkflow)](https://github.com/sartography/SpiffWorkflow/pulls)

Expand All @@ -45,7 +45,7 @@ _A complete list of the latest features is available with our [release notes](ht
version 1.0._

## Code Examples and Documentation
Detailed documentation is available on [ReadTheDocs](https://spiffworkflow.readthedocs.io/en/latest/)
Detailed documentation is available on [spiff.works](https://spiff.works/docs/spiffworkflow/).
Also, checkout our [example application](https://github.com/sartography/spiff-example-cli), which we
reference extensively from the Documentation.

Expand Down
8 changes: 4 additions & 4 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
## What's Changed

Since the last release, we've continued to work on making SpiffWorkflow easier to use and internally consistent as well as
added a few new features to support [SpiffArena](https://www.spiffworkflow.org/).
added a few new features to support [SpiffArena](https://spiff.works/).

## Breaking Changes from 2.x:

* We refactored task iteration to allow for greater flexibility in selecting tasks. Usage of `workflow.get_tasks` has changed.
See [Filtering Tasks](https://spiffworkflow.readthedocs.io/en/latest/bpmn/workflows.html#filtering-tasks) for documentation.
See [Filtering Tasks](https://spiff.works/docs/spiffworkflow/bpmn/workflows.html#filtering-tasks) for documentation.
* We've continued to reorganize files in order to impose more structure on the package. Imports have changed (but we've added
`__init__.py` files to make these reorganizations less painful in the future). See an overview of the package structure at
[What's in the BPMN Module](https://spiffworkflow.readthedocs.io/en/latest/bpmn/imports.html).
* We've simplified the BPMN serializer. [BPMN Serializer](https://spiffworkflow.readthedocs.io/en/latest/bpmn/serialization.html)
[What's in the BPMN Module](https://spiff.works/docs/spiffworkflow/bpmn/imports.html).
* We've simplified the BPMN serializer. [BPMN Serializer](https://spiff.works/docs/spiffworkflow/bpmn/serialization.html)

## Features and Improvements

Expand Down
49 changes: 49 additions & 0 deletions doc/bin/serve_docs
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
#!/usr/bin/env bash
set -euo pipefail

DOCS_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
HOST="${HOST:-127.0.0.1}"
PORT="${PORT:-8001}"

case "${1:-}" in
-h|--help|help)
cat <<EOF
Usage: doc/bin/serve_docs

Environment:
HOST Bind host, default 127.0.0.1
PORT Bind port, default 8001

Examples:
doc/bin/serve_docs
PORT=8010 doc/bin/serve_docs
EOF
exit 0
;;
"")
;;
*)
echo "Unknown argument: $1" >&2
echo "Usage: doc/bin/serve_docs" >&2
exit 1
;;
esac

if ! command -v uv >/dev/null 2>&1; then
echo "uv is required. Install it from https://docs.astral.sh/uv/." >&2
exit 1
fi

cd "$DOCS_DIR"

echo "Serving SpiffWorkflow docs at http://$HOST:$PORT"
echo "Source: $DOCS_DIR"

exec uv run \
--extra doc \
--with sphinx-autobuild \
sphinx-autobuild \
--host "$HOST" \
--port "$PORT" \
. \
_build/html
2 changes: 1 addition & 1 deletion doc/bpmn/camunda/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Using the Camunda Configuration Module
SpiffWorkflow does not aim to support all of Camunda's proprietary extensions.
Many of of the items in the Camunda Properties Panel do not work. And
major features of SpiffWorkflow (Messages, Data Objects, Service Tasks, Pre-Scripts, etc...)
can not be configured in the Camunda editor. Use `SpiffArena <https://www.spiffworkflow.org/posts/articles/get_started/>`_
can not be configured in the Camunda editor. Use `SpiffArena <https://spiff.works/>`_
to build and test your BPMN models instead!

Earlier users of SpiffWorkflow relied heavily on Camunda's modeler and several of our task spec
Expand Down
3 changes: 1 addition & 2 deletions doc/bpmn/script_engine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ their parameters that can be displayed to a BPMN author in the Service Task conf
hard-coding a list of services in
`app.js <https://github.com/sartography/bpmn-js-spiffworkflow/blob/0a9db509a0e85aa7adecc8301d8fbca9db75ac7c/app/app.js#L47>`_
and as suggested, it would be reasonably straightforward to replace this with a API call.
`SpiffArena <https://www.spiffworkflow.org/posts/articles/get_started/>`_ has robust mechanisms for handling this that
`SpiffArena <https://spiff.works/>`_ has robust mechanisms for handling this that
might serve as a model for you.

How this all works is obviously heavily dependent on your application, so we won't go into further detail here, except
Expand Down Expand Up @@ -496,4 +496,3 @@ To load this example:
./runner.py -e spiff_example.spiff.custom_exec add -p order_product \
-b bpmn/tutorial/{top_level_script,call_activity_script}.bpmn
./runner.py -e spiff_example.spiff.custom_exec

14 changes: 10 additions & 4 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ What is SpiffWorkflow?

.. image:: images/logo.png
:align: center
:target: https://www.spiffworkflow.org
:target: https://spiff.works

**SpiffWorkflow is a library that provides a flexible workflow execution environment.**

Expand All @@ -27,12 +27,12 @@ this core.

Extensive documentation about BPMN and how SpiffWorkflow interprets it, as well as information about custom extensions
implemented in the :code:`spiff` package can be found in the
`Spiff Arena documentation <https://spiff-arena.readthedocs.io/en/latest/>`_. If you are not familiar with BPMN, you
`Spiff Arena documentation <https://spiff.works/docs/spiff-arena/>`_. If you are not familiar with BPMN, you
should start there. If you are looking for a full-fledged BPMN application, you can start and end there. This
documentation will focus on the library itself and is geared towards developers who are building their own
applications.

Please visit `SpiffWorkflow.org <https://www.spiffworkflow.org>`_ for
Please visit `spiff.works <https://spiff.works>`_ for
additional articles, videos, and tutorials about SpiffWorkflow and its
related projects including SpiffArena, Service Connectors, and BPMN.js
extensions.
Expand All @@ -48,7 +48,7 @@ Support
You can find us on our `Discord Channel <https://discord.gg/BYHcc7PpUC>`_

Commercial support for SpiffWorkflow is available from
`Sartography <https://sartography.com>`_
Sartography at `spiff.works <https://spiff.works>`_


Contents
Expand All @@ -60,3 +60,9 @@ Contents
modules
bpmn/index
core/index

.. toctree::
:maxdepth: 1
:caption: Additional Documentation

SpiffWorks Learn <https://spiff.works/learn/>
2 changes: 1 addition & 1 deletion doc/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Spiff BPMN Extensions
---------------------

This module extends the generic BPMN implementation with support for custom extensions used by
`Spiff Arena <https://spiff-arena.readthedocs.io/en/latest/>`_.
`Spiff Arena <https://spiff.works/docs/spiff-arena/>`_.

Camunda BPMN Extensions
-----------------------
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ dynamic = ["version"]

[project.urls]
Homepage = "https://github.com/sartography/SpiffWorkflow"
Documentation = "https://spiffworkflow.readthedocs.io"
Documentation = "https://spiff.works/docs/spiffworkflow/"

[project.optional-dependencies]
doc = [
Expand Down
Loading