Commit Graph

144 Commits

Author SHA1 Message Date
dependabot[bot] fcb52cbe67
Bump sphinx-rtd-theme from 1.2.0 to 2.0.0 (#975)
Bumps [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) from 1.2.0 to 2.0.0.
- [Changelog](https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/changelog.rst)
- [Commits](https://github.com/readthedocs/sphinx_rtd_theme/compare/1.2.0...2.0.0)

---
updated-dependencies:
- dependency-name: sphinx-rtd-theme
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-02-06 08:42:00 -08:00
usama9500 aaec9f6ffc
Maximum and Minimum Date Validation (#935) 2024-02-01 09:55:01 -08:00
usama9500 11d9e32d1f
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-16 20:35:45 -08:00
burnettk ae9b16165c
let docs build with new python, and fix json 2024-01-10 19:02:25 -05:00
burnettk 14f2107b91
update docs 2024-01-10 18:47:35 -05:00
jasquat d5c5bc12ae
Feature/side by side layout (#858)
* WIP: work for side-by-side layout in json forms w/ burnettk

* added support in ObjectFieldTemplate to support side-by-side layout w/ burnettk

* added a restricted grid template for half width forms

* display the error message if field mentioned in ui:layout but the field does not exist

* added docs for side-by-side layout w/ burnettk

* update script

---------

Co-authored-by: jasquat <jasquat@users.noreply.github.com>
Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2024-01-05 15:49:40 -05:00
jasquat dc0aa584be
imported patch from old FAQ_3rd_Set branch w/ burnettk (#810)
* imported patch from old FAQ_3rd_Set branch w/ burnettk

* updates while reviewing

---------

Co-authored-by: jasquat <jasquat@users.noreply.github.com>
Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-12-20 15:23:38 -08:00
Kevin Burnett 5cceb52756 Numeric range field added (#799) (#800)
* Numeric range field added (#799)

Added a custom field to handle numeric ranges. The field checks for the first key in the properties of the schema and will add min and max to it when the values are put in.

* autofix lint stuff

* updates to simplify the code, fix a few ux issues, and make more inline with current conventions w/ burnettk

* removed subkey from numeric range and added validation to ensure max is greater than min w/ burnettk

* added some comments to clarify how to use numeric range w/ burnettk

* added some documentation for the numeric range field w/ burnettk

---------

Co-authored-by: Kayvon-Martinez <142514475+Kayvon-Martinez@users.noreply.github.com>
Co-authored-by: burnettk <burnettk@users.noreply.github.com>
Co-authored-by: jasquat <jasquat@users.noreply.github.com>
2023-12-13 12:50:26 -06:00
usama9500 088b70708b New tickets documentation (#786)
* New tickets documentation

* resolve topic name issue
2023-12-03 08:23:53 -08:00
burnettk 0089788816 check out bpmn unit test wish list item 2023-11-24 13:45:44 -05:00
fzzylogic 55983a5aea Update data_stores.md (#707)
nit
2023-11-22 12:39:48 +00:00
jasquat dcaea149de lower case png so markdown references are correct 2023-11-17 09:14:08 -05:00
Phillana26 3d96772fa6 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 14:37:18 -08:00
jasquat 449fe87d43 Feature/deny macro on permission (#672)
* look for deny in the permission action rather than in the target uri and updated the documentation w/ burnettk

* added depecation warning if allowed_permissions is being used intead of actions w/ burnettk

---------

Co-authored-by: jasquat <jasquat@users.noreply.github.com>
2023-11-15 11:46:56 -05:00
usama9500 6136a51c85 Added new features (#620)
* Added new features

* ventilate prose

* tweaks

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-11-14 09:48:40 -08:00
burnettk 207f9475a0 update the docs on data 2023-11-03 11:38:59 -04:00
fzzylogic f1d6b0aec8 docs: Fix broken table (#603)
Co-authored-by: Andrew <andrew@plannerdev.com>
2023-11-02 05:59:43 -07:00
usama9500 85caf8e96c FAQ Questions, Guest Feature and Display UI Help in forms (#555)
* FAQ Questions and Display UI Help in forms

* Adding guest content

* fixing KB Comments

* Removing Library Question

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-10-31 08:28:45 -07:00
burnettk 92e51baca3 document additional logic over and above that provided by react json schema form lib 2023-10-18 18:45:57 -04:00
usama9500 5fb4171508 Features (#528)
* Features

* Fixing build issue

* Fixing FAQ link

* edits to quick start and faq

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-10-10 10:21:20 -07:00
burnettk e99ebd5424 document functions available to script tasks, tho needs params 2023-10-04 21:41:29 -04:00
Phillana26 125e0d5f7e events and signals (#508)
* events and signals

* update signal_relationships.png issue

* tweaking

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-09-25 18:43:42 -07:00
usama9500 60c143aa94 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-25 18:43:27 -07:00
burnettk 183e7ab379 fix heading and install markdownlint if needed 2023-09-15 20:29:02 -04:00
burnettk 57262451eb remove broken links under indices and tables 2023-09-15 20:20:36 -04:00
usama9500 765f744721 Adding content for features (#481) 2023-09-12 09:43:49 -07:00
usama9500 6f8528dc1d 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 12:07:39 -04:00
Phillana26 94c9693347 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 05:42:13 -07:00
Kevin Burnett 56c1823646 script to update a doc page with chatgpt (#451)
Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-08-24 11:49:17 -07:00
burnettk 65b2887f9f document some of the more obscure features 2023-08-22 23:30:02 -04:00
jasquat 29620cb17f Feature/add support permissions (#445)
* added support perm macro which removes secrets perms w/ burnettk

* support perm macro inherits from basic now and updated docs on permissions to be more accurate w/ burnettk

---------

Co-authored-by: jasquat <jasquat@users.noreply.github.com>
2023-08-22 08:53:26 +05:30
usama9500 b661f3b930 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 08:42:58 -04:00
usama9500 5615be9a20 Updating the structure file (#420)
* updating the structure

* Adding Alex Suggestions
2023-07-28 11:16:36 -04:00
Phillana26 3e43a4ff7d 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 09:10:31 -07:00
Phillana26 e276e649c7 Articles (#395)
* articles section

* Articles section updated

---------

Co-authored-by: Kevin Burnett <18027+burnettk@users.noreply.github.com>
2023-07-19 13:27:15 -07:00
usama9500 3fe48fb6a6 Adding Building blocks (#381)
* Adding Building blocks

* Adding examples of building blocks

* Formatting

* Formatting images and text

* Fixing KB Comments

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-07-13 10:23:46 -04:00
jasquat 277d37e494 commented out references to how_to doc since how_to was deleted w/ burnettk 2023-07-07 16:56:37 -04:00
Phillana26 484b93887e 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 16:00:57 -04:00
usama9500 92bd5d8883 Adding Essential Example (#365)
* Adding Essential Example

* fixing lowercase Images

* fixing image size

* fixing build issues

* Image Alignments

* minor tweaks.

---------

Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-07-07 15:39:00 -04:00
Phillana26 340af365ff Create how to (#348)
* how_to_section

* how-to-before-index

* Fixed links and image sizes

* fix links and images size

* push

* kill last notion links

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-07-07 15:10:24 -04:00
jasquat e4bf22f5cf Feature/interstitial summary part 3 (#367)
* throw an error if backend gives a 500 from interstitial page w/ burnettk

* turn unexpected errors for the interstitial page into event stream responses to avoid error misdirection

* pyl

* raise the api_error from the original and make the render_data method private

* Feature/interstitial summary (#337)

* * Process instance logs and messages are now components rather than pages, and are included within tabs on the process instance page, along with the diagram.
* Removed the Zoom and Move modules when showing the readonly
  Diagram.  Assured this readonly view is resized to fit the space when possible.
* Checkbox Widget no longer displays a duplicate label.
* CSS Tweaks
  * All pages are limited to a max display width of 1440, with auto margins to center the main content on the page.
  * "Show" pages, like ProcessInstanceShow, TaskShow have the primary content limited to 1000, also with auto-margins.
  * Paragraphs, headings, blockquotes, list items are limited to a width of 640.
  * Reduced margin bottom on all breadcrumbs.
  * Slightly reduced the width and margin of tiles
  * ordered lists and unordered lists show numbers and bullets now.
* End user Instructions component can, optionally, auto-collapse, so that only a portion is displayed, along with a toggle.  This is how it is set up for the ProcessInstanceShow page.
* Greatly reduced the lag in the interstitial page when doing a re-direct.

* run_pyl

* kill console

* wait for permissionsLoaded too since we are using ability.can

* Previous change removed the top level Messages page - this re-adds it.

* I am always, ALWAYS shocked at how I can not wrap my head around when and where to use "useEffect".

This should cause the show/hide Instructions toggle to only show when useful.

* Minor cleanup on the process instance properties display.

* linting

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>

* Fix a linting error.

* minor permissions related fixes for the new ui.

* Revert "Revert "Feature/better subworkflow management (#331)""

This reverts commit 48dcde8faf.

* do not execute tasks from the process instance show page w/ burnettk

* pyl w/ burnettk

* Very minor UI tweak to resolve a number of issues mentioned in SPIFF-316 Notion Ticket:

* Markdown links now open in a new window
* Tables on the home pages are now contained within Grids to better align them with the other content that is in a grid.
* Right aligned the "process instance list link" button to it is flush right with the table underneath
* Gave a little more breathing room the content on the info/metadata in the process instance view .

* updated docker image build action to contain the appropriate version info w/ burnettk

* properly resize to the available columns depending on s/m/l

---------

Co-authored-by: jasquat <jasquat@users.noreply.github.com>
Co-authored-by: Dan Funk <daniel.h.funk@gmail.com>
Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-07-03 10:54:54 +05:30
jasquat 6ba2d23e09 added build command for docs and created github action w/ burnettk 2023-06-26 11:33:27 -04:00
usama9500 e9322b29c1 fixing main (#351) 2023-06-26 10:40:42 -04:00
usama9500 ee55ef66aa Spiffdemo getting started section (#350)
* Spiffdemo getting started section

* ventilated prose

* Updates images

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-06-26 13:39:41 +05:00
Phillana26 2afd49a3e4 Create_how_to (#347)
* how_to_section

* how-to-before-index
2023-06-23 00:13:03 +05:00
burnettk ecf0a423be Revert "processes to process models"
This reverts commit 294eff7873.
2023-06-19 09:08:46 -04:00
burnettk 294eff7873 processes to process models 2023-06-19 08:27:06 -04:00
burnettk 53d73e13a3 Revert "Feature/interstitial summary (#337)"
This reverts commit c48f3a458b.
2023-06-19 08:19:36 -04:00
Dan Funk c48f3a458b Feature/interstitial summary (#337)
* * Process instance logs and messages are now components rather than pages, and are included within tabs on the process instance page, along with the diagram.
* Removed the Zoom and Move modules when showing the readonly
  Diagram.  Assured this readonly view is resized to fit the space when possible.
* Checkbox Widget no longer displays a duplicate label.
* CSS Tweaks
  * All pages are limited to a max display width of 1440, with auto margins to center the main content on the page.
  * "Show" pages, like ProcessInstanceShow, TaskShow have the primary content limited to 1000, also with auto-margins.
  * Paragraphs, headings, blockquotes, list items are limited to a width of 640.
  * Reduced margin bottom on all breadcrumbs.
  * Slightly reduced the width and margin of tiles
  * ordered lists and unordered lists show numbers and bullets now.
* End user Instructions component can, optionally, auto-collapse, so that only a portion is displayed, along with a toggle.  This is how it is set up for the ProcessInstanceShow page.
* Greatly reduced the lag in the interstitial page when doing a re-direct.

* run_pyl

* kill console

* wait for permissionsLoaded too since we are using ability.can

* Previous change removed the top level Messages page - this re-adds it.

* I am always, ALWAYS shocked at how I can not wrap my head around when and where to use "useEffect".

This should cause the show/hide Instructions toggle to only show when useful.

* Minor cleanup on the process instance properties display.

* linting

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-06-16 09:53:20 -04:00
danfunk 78c5ca1251 updaing the wishlist. 2023-06-13 11:31:28 -04:00
Kevin Burnett 41ccb7d863 remove backend docs dir (#325)
* remove backend docs dir

* remove reference to gone dir

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-06-12 09:28:58 -07:00
usama9500 25ac6a2e10 update elements and content (#318) 2023-06-09 12:26:42 -07:00
jbirddog 2e2dd0db3a Update wish_list.md (#322)
Adding some connector proxy wish list items
2023-06-09 12:24:17 -07:00
usama9500 1c98b5d845 Docs/basics content (#315)
* Basics content add

* Fixing the stylesheet so forms wrap correctly.

* fixing basics symbols

---------

Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-06-09 12:31:01 +05:00
usama9500 ab5fa70e41 Basics content add (#310)
* Basics content add
* Fixing the stylesheet so forms wrap correctly.

---------

Co-authored-by: danfunk <daniel.h.funk@gmail.com>
2023-06-08 08:27:58 -04:00
Dan Funk bba28f1b9e File tree update (#306)
* File tree update

* Update learn_basics.md

---------

Co-authored-by: Phillana26 <134319064+Phillana26@users.noreply.github.com>
2023-06-07 12:39:43 +05:00
jbirddog 228a06b876 Start of DevOps/Connector Proxy docs (#301)
* WIP, moving over connector proxy docs

* Updated docs
2023-06-06 10:21:08 -07:00
usama9500 2da64ca183 fixing column symbols 2023-06-06 18:55:09 +05:00
usama9500 f4bb2c36f5 adding content in basics 2023-06-06 13:42:22 +05:00
usama950 ec9298ee0f Updating structure of getting started section 2023-06-03 13:51:24 +05:00
danfunk 7743b6c87f 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 08:25:39 -04:00
jasquat cfd95a22f2 added admin guide doc to explain how to delete and terminate a process instance w/ burnettk 2023-06-01 16:55:30 -04:00
danfunk c7db6f9bdd updaing the wishlist. 2023-06-01 15:08:55 -04:00
danfunk 247735b0d4 adding wishlist to the documentation. 2023-05-31 14:04:37 -04:00
usama950 cb995b53a6 Updating content 2023-05-30 16:03:41 +05:00
usama950 37456048cf Updating content 2023-05-30 15:52:32 +05:00
usama9500 1d8a25429e images replaced on how to respond to request 2023-05-26 19:11:35 +05:00
usama9500 4ea129caa7 Getting started section updates 2023-05-25 19:26:01 +05:00
usama9500 7206da17b8 Merge branch 'main' of https://github.com/sartography/spiff-arena 2023-05-24 19:22:54 +05:00
usama9500 80f74f239c Text removed 2023-05-24 19:18:41 +05:00
burnettk 68af0ad1dc add docs on BPMN unit tests 2023-05-23 18:07:57 -04:00
usama9500 ef1cf63a35 Fixing Dan's constant seplling mistakes 2023-05-23 21:19:10 +05:00
calexh-sar fa6b0c170b Changed 'things' to 'formatting options' 2023-05-23 12:06:24 -04:00
usama9500 57f624f7ca Fixing Dan's constant seplling mistakes 2023-05-23 11:43:50 +05:00
usama9500 0dcb5de540 Merge branch 'main' of https://github.com/sartography/spiff-arena 2023-05-23 11:38:27 +05:00
usama9500 cf9c88284e Fixing Dan's constant seplling mistakes 2023-05-23 11:36:04 +05:00
Phillana26 57dbf4d03b Phillana Undo 2023-05-22 22:13:37 +02:00
Phillana26 2ec53b39c0 Phillana Test 2023-05-22 22:09:35 +02:00
burnettk eb0414a66d add make lint target 2023-05-21 19:25:52 -04:00
burnettk d137af65e5 add lint target for make 2023-05-20 15:33:00 -04:00
burnettk 881d5a08ba fix all markdownlint issues 2023-05-20 15:28:53 -04:00
burnettk 5f6ff7a874 doc updates 2023-05-20 14:35:32 -04:00
burnettk 0846f35590 doc markdownlint 2023-05-19 10:54:01 -04:00
burnettk ec7ecc1706 edit documetation page 2023-05-19 10:18:14 -04:00
danfunk 4afe3ca812 typos. 2023-05-18 16:35:08 -04:00
danfunk a14897d42e one more note. 2023-05-18 16:20:54 -04:00
danfunk c2a206960f One more update on syncing changes. 2023-05-18 16:18:23 -04:00
danfunk 36fa20afd0 Adding details on how to commit changes. 2023-05-18 16:17:52 -04:00
danfunk 6fddb05594 adding how to document instructions. 2023-05-18 16:12:05 -04:00
danfunk 0580dd30ab adding how to document instructions. 2023-05-18 16:11:02 -04:00
danfunk 41ee224654 adding a note 2023-05-18 12:57:06 -04:00
danfunk ec19387b65 use requirements.txt for readthedocs build. 2023-05-18 11:26:47 -04:00
danfunk fe20a86583 adding sphinx auto-api 2023-05-18 11:08:42 -04:00
danfunk 670a1d5363 initial set of docs for SpiffWorkflow 2023-05-18 10:49:44 -04:00