sartography
/
spiff-arena
mirror of https://github.com/sartography/spiff-arena.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
spiff-arena/docs/index.md

91 lines
2.1 KiB
Markdown
Raw Normal View History

add docs on BPMN unit tests
2023-05-23 22:07:57 +00:00
# Welcome to SpiffWorkflow's documentation
initial set of docs for SpiffWorkflow
2023-05-18 14:49:44 +00:00
```{toctree}
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
:maxdepth: 1
Documentation Updates - updated conf.py with some new settings - updated the documentation - provided an example of section heading - added a few additional requirements
2023-06-02 12:25:39 +00:00
:caption: Getting Started
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
Getting_Started/quick_start.md
Documentation Updates - updated conf.py with some new settings - updated the documentation - provided an example of section heading - added a few additional requirements
2023-06-02 12:25:39 +00:00
```
Tech docs (#1527) * tech docs * more tech docs * add process doc * deploy docs * doc deployment --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2024-05-21 19:03:48 +00:00
```{toctree}
:maxdepth: 1
:caption: Technical Docs
dev/index.md
dev/setup.md
dev/backend.md
dev/frontend.md
dev/connector_proxy.md
dev/process.md
```
Documentation Updates - updated conf.py with some new settings - updated the documentation - provided an example of section heading - added a few additional requirements
2023-06-02 12:25:39 +00:00
```{toctree}
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
:maxdepth: 1
Updating the structure file (#420) * updating the structure * Adding Alex Suggestions
2023-07-28 15:16:36 +00:00
:caption: Building Diagrams
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
Building_Diagrams/learn_basics.md
Building_Diagrams/bpmn.md
Building_Diagrams/Forms.md
Building_Diagrams/gateways.md
events and signals (#508) * events and signals * update signal_relationships.png issue * tweaking --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-09-26 01:43:42 +00:00
Building_Diagrams/events.md
add message events, pools and lanes, signals (#448) * add message events, pools and lanes, signals * changed PNG to png * corrected png error --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-08-27 12:42:13 +00:00
Building_Diagrams/message_events.md
events and signals (#508) * events and signals * update signal_relationships.png issue * tweaking --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-09-26 01:43:42 +00:00
Building_Diagrams/signal_events.md
Condition, escalation, timer events (#681) * Condition, escalation,timer events * tweaks * rename * ventilate prose --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-11-16 22:37:18 +00:00
Building_Diagrams/timer_events.md
Building_Diagrams/escalation_events.md
Building_Diagrams/conditional_events.md
Error Events Documentation (#1159) * Error Events Documentation * Updates * Fixing detected issues * Adding Examples of Error Events * Update docs/Building_Diagrams/error_events.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Adding Examples of Error Boundary Events --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2024-03-11 19:28:34 +00:00
Building_Diagrams/error_events.md
add message events, pools and lanes, signals (#448) * add message events, pools and lanes, signals * changed PNG to png * corrected png error --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-08-27 12:42:13 +00:00
Building_Diagrams/Displaying_Content.md
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
Building_Diagrams/Script_Tasks.md
Building_Diagrams/sub-processes_and_call_activities.md
update the docs on data
2023-11-03 15:38:59 +00:00
Building_Diagrams/data.md
Adding Example of Signal Events and New documentation on Multiinstanc… (#1204) * Adding Example of Signal Events and New documentation on Multiinstance tasks * edits while reviewing * Updates based on feedback --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2024-03-21 16:24:47 +00:00
Building_Diagrams/multiinstance.md
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
Building_Diagrams/dmn.md
Extension section (#446) * Extension section * fixing build issues * some updates while reviewing --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com> Co-authored-by: Dan Funk <daniel.h.funk@gmail.com>
2023-08-29 16:07:39 +00:00
Building_Diagrams/Extensions.md
add message events, pools and lanes, signals (#448) * add message events, pools and lanes, signals * changed PNG to png * corrected png error --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-08-27 12:42:13 +00:00
Building_Diagrams/pools_and_lanes.md
Adding content for features (#481)
2023-09-12 16:43:49 +00:00
Building_Diagrams/Builtin_examples.md
Updating the structure file (#420) * updating the structure * Adding Alex Suggestions
2023-07-28 15:16:36 +00:00
```
```{toctree}
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
:maxdepth: 1
Updating the structure file (#420) * updating the structure * Adding Alex Suggestions
2023-07-28 15:16:36 +00:00
:caption: Debugging Diagrams
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
Debugging_Diagrams/bpmn_unit_tests.md
document some of the more obscure features
2023-08-23 03:30:02 +00:00
Debugging_Diagrams/process_error_handling.md
Private fields using data object and Viewing task instance history (#899) * Private fields using data object and Viewing task instance history * edits while reviewing --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2024-01-17 04:35:45 +00:00
Debugging_Diagrams/Private_data.md
Documentation Updates - updated conf.py with some new settings - updated the documentation - provided an example of section heading - added a few additional requirements
2023-06-02 12:25:39 +00:00
```
initial set of docs for SpiffWorkflow
2023-05-18 14:49:44 +00:00
Start of DevOps/Connector Proxy docs (#301) * WIP, moving over connector proxy docs * Updated docs
2023-06-06 17:21:08 +00:00
```{toctree}
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
:maxdepth: 1
Updating the structure file (#420) * updating the structure * Adding Alex Suggestions
2023-07-28 15:16:36 +00:00
:caption: DevOps - Installation & Integration
Tech docs (#1527) * tech docs * more tech docs * add process doc * deploy docs * doc deployment --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2024-05-21 19:03:48 +00:00
DevOps_installation_integration/deployment.md
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
DevOps_installation_integration/admin_and_permissions.md
DevOps_installation_integration/permission_url.md
DevOps_installation_integration/configure_connector_proxy.md
DevOps_installation_integration/deploy_aws_lambda.md
Adding content for features (#481)
2023-09-12 16:43:49 +00:00
DevOps_installation_integration/Secrets.md
Celery docs and debug (#1328) * added script to import process instance and updated some docs for redis and celery w/ burnettk * pyl and removed bad gitignore w/ burnettk --------- Co-authored-by: jasquat <jasquat@users.noreply.github.com>
2024-04-02 20:13:18 +00:00
DevOps_installation_integration/redis_celery_broker.md
document path-based routing
2024-04-04 00:28:09 +00:00
DevOps_installation_integration/path_based_routing.md
add docs for process model management (#1379) Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2024-04-10 17:50:53 +00:00
DevOps_installation_integration/process_model_management.md
Start of DevOps/Connector Proxy docs (#301) * WIP, moving over connector proxy docs * Updated docs
2023-06-06 17:21:08 +00:00
```
add message events, pools and lanes, signals (#448) * add message events, pools and lanes, signals * changed PNG to png * corrected png error --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-08-27 12:42:13 +00:00
Documentation Updates - updated conf.py with some new settings - updated the documentation - provided an example of section heading - added a few additional requirements
2023-06-02 12:25:39 +00:00
```{toctree}
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
:maxdepth: 1
Adding content for features (#481)
2023-09-12 16:43:49 +00:00
:caption: Support & Administration
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
Support/suspend_resume_terminate.md
Adding content for features (#481)
2023-09-12 16:43:49 +00:00
Support/Welcome_Messages.md
FAQ and Messages (#510) * FAQ and Messages * fix some branding things and remove some duplication --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-09-26 01:43:27 +00:00
Support/Running_Server_Locally.md
Support/FAQ.md
adding wishlist to the documentation.
2023-05-31 18:04:37 +00:00
```
File tree update (#306) * File tree update * Update learn_basics.md --------- Co-authored-by: Phillana26 <134319064+Phillana26@users.noreply.github.com>
2023-06-07 07:39:43 +00:00
fixing main (#351)
2023-06-26 14:40:42 +00:00
```{toctree}
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
:maxdepth: 1
in_depth_topics (#376) * in_depth_topics * Mostly fixing capitalized names and some foward vs back-slashes in file paths. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-07-07 20:00:57 +00:00
:caption: Appendices
Bpmn_section (#412) * how to and spiff sparkles * how to and spiff spiffsparkles * rename data_object_properties.png * change name images/data_object_prop.png * downcase png files --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-07-24 16:10:31 +00:00
appendices/glossary.md
Articles (#395) * articles section * Articles section updated --------- Co-authored-by: Kevin Burnett <18027+burnettk@users.noreply.github.com>
2023-07-19 20:27:15 +00:00
appendices/articles.md
updating structure with proper file names (#422) * updating structure with proper file names * fixing build issues * build issues * fixing build errors * Adding support section * a little less noise on the index page - maybe we look into adding some intro content here. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-08-01 12:42:58 +00:00
appendices/bpmn_terminology.md
Updating the structure file (#420) * updating the structure * Adding Alex Suggestions
2023-07-28 15:16:36 +00:00
documentation/documentation.md
wish_list/wish_list.md
in_depth_topics (#376) * in_depth_topics * Mostly fixing capitalized names and some foward vs back-slashes in file paths. --------- Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-07-07 20:00:57 +00:00
```
FAQ and Messages (#510) * FAQ and Messages * fix some branding things and remove some duplication --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-09-26 01:43:27 +00:00
## Indices and tables
Celery docs and debug (#1328) * added script to import process instance and updated some docs for redis and celery w/ burnettk * pyl and removed bad gitignore w/ burnettk --------- Co-authored-by: jasquat <jasquat@users.noreply.github.com>
2024-04-02 20:13:18 +00:00
- [](genindex)
- [](modindex)
- [](search)