Commit Graph

79 Commits

Author SHA1 Message Date
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