sartography/spiff-arena
1
0
Fork 0
mirror of https://github.com/sartography/spiff-arena.git synced 2025-02-28 17:10:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Getting started section updates

Browse Source
This commit is contained in:
usama9500 2023-05-25 19:26:01 +05:00
parent aba88d6c7c
commit bfec4c30b6
1 changed files with 9 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/quick_start/quick_start.md
View File

@ -9,9 +9,9 @@
## 🚀 Getting Started with SpiffWorkflow
SpiffWorkflow is a platform that facilitates the execution of business processes performed within the Status platform.
SpiffWorkflow is a platform that facilitates the execution of business processes. To begin using SpiffWorkflow, it is necessary to acquire the appropriate credentials and URL.
To access SpiffWorkflow, simply sign in using your Keycloak account. Once you have successfully signed in to the Spiff platform, it is crucial to familiarize yourself with the various sections within the SpiffWorkflow. This will enable you to gain a comprehensive understanding of the interface.
Upon receiving the credentials, here is how you can get started with SpiffWorkflow!
```{image} images/Untitled.png
:alt: Login Page
@ -20,13 +20,7 @@ To access SpiffWorkflow, simply sign in using your Keycloak account. Once you ha
```{image} images/Untitled_1.png
:alt: Home Page
:width: 45%
```
```{admonition} Signing In
:class: warning
⚠️ In the event that you encounter any difficulties signing in to Spiff, please reach out to Jakub (**@jakubgs**) on Discord for assistance and further guidance.
:width: 53%
```
Here, we will provide a generic overview of each section step by step, allowing you to navigate and engage with the platform more effectively.
@ -41,7 +35,7 @@ Once you are signed in, you can start exploring the home page. The home page has
- The "Completed" section allows you to view all completed process instances, including those initiated by you, those initiated by other SpiffWorkflow users with tasks completed by you and if applicable, those with tasks completed by a group of which you are a member.
- The “Start New” section displays the processes you are permitted to start according to your role.
```{admonition} Signing In
```{admonition} Key terms
:class: info
💡 **Process:** A process is a sequence of tasks that must be completed to achieve a specific goal.
@ -58,8 +52,7 @@ If you are a member of a team, you may also have one or more Instances with task
The process section provides a comprehensive view of the process ecosystem by showcasing process groups and process models.
```{admonition} Process Groups
:class: info
💡 A **process group** is a way of grouping a bunch of **process models.** A **process model** contains all the files necessary to execute a specific process.
A **process group** is a way of grouping a bunch of **process models** and a **process model** contains all the files necessary to execute a specific process.
```
--
@ -67,17 +60,13 @@ The process section provides a comprehensive view of the process ecosystem by sh
### Step 3: Explore the Process Instances section
The Process Instance section provides a detailed view of individual process instances, allowing you to track their progress and manage them effectively. This section includes essential information such as the instance ID, process name, the individual who started the process, the end date, and the current status.
The Process Instance section provides a detailed view of individual process instances, allowing you to track their progress and manage them effectively.
This section includes essential information such as the instance ID, process name, the individual who started the process, the end date, and the current status.
![Untitled](images/Untitled_5.png)
```{admonition} Desktop Notifications
:class: info
💡 To receive SpiffWorkflow notifications in StatusApp Desktop, Public key from your Status account should be added to your **Bamboo profile**. This will ensure that workflow-related notifications are sent to you.
```
When getting started with SpiffWorkflow, it's essential to take the time to explore and familiarize yourself with the platform's interface and features. Feel free to ask questions about the platform's features or how to get started. The PPG team is always on hand to provide assistance and support when needed.
When getting started with SpiffWorkflow, it's essential to take the time to explore and familiarize yourself with the platform's interface and features. Feel free to ask questions about the platform's features or how to get started.
---