Skip to content

Commit 1322e42

Browse files
authored
Merge pull request #5 from PROCEED-Labs/update-create-process-css
Edited Create Process site according to feedback, removing and replacing some of the text and screenshots and made some style adjustments re-named the CSS file for image sizes to image_sizes.css and import it only once in index.mdx, Nextra applies it to the whole site so all image adjustments can be done in this file from now on without losing the markdown expand feature added the 'Copy and Share the Process' site and it's screenshots added the 'Organize multiple Processes' site and it's screenshots
2 parents 121ac14 + 0e76193 commit 1322e42

21 files changed

Lines changed: 235 additions & 127 deletions

content/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import "/styles/image_sizes.css";
2+
13
# PROCEED User Documentation
24

35
PROCEED is an open-source Business Process Management System (BPMS) specialized on the intelligent and user-friendly creation, execution and monitoring of processes.

content/quick-start/qs-create-process.mdx

Lines changed: 73 additions & 81 deletions
Large diffs are not rendered by default.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
### Organizing processes
3+
4+
In this section, we will quickly show how you can organize your processes into folders to maintain a structured and efficient workspace
5+
in the PROCEED editor.
6+
7+
Using the three-dotted button next to **Create Process**, or by right-clicking on empty space, you can create new folders to organize your processes.
8+
9+
We recommend structuring your folders by **department**, **function**, or **process type**, depending on what best suits your team's workflow.
10+
For example, you might create folders like **HR**, **Finance**, or **Operations** to keep related processes grouped together.
11+
You can also nest folders to reflect your organizational hierarchy — for instance, placing an Onboarding folder inside the HR folder.
12+
13+
To customize your view, use the three-dotted button in the top-right corner of the table to display additional properties.
14+
You can sort columns by clicking on their headers, making it easier to locate specific items.
15+
In the top-right corner, an arrow button allows you to toggle detailed meta-data for the currently selected item.
16+
![table_options](/images/quick-start-organize/table_options.png)
17+
18+
You can switch to a **tile view** using the button in the top-right corner of the workspace. This layout will also display preview images of your processes
19+
to make it easier to quickly recognize processes visually. To open a folder you now have to double-click it.
20+
![switch_to_tiles](/images/quick-start-organize/switch_to_tiles.png)
21+
22+
You can also **drag and drop** processes to move them between folders — this works seamlessly in both list and tile view. To move a process up one level,
23+
you can drag it onto the Parent Folder entry at the top of the list.
24+
![drag_and_drop](/images/quick-start-organize/drag_and_drop.png)
25+
26+
By right-clicking a process, you gain access to additional actions such as opening the process in a **new tab**, copying a direct link to **share** with others,
27+
or creating a **duplicate**.
28+
![right_click](/images/quick-start-organize/right_click.png)
29+
30+
You also have the option to **export** one or multiple processes directly from this view using the action bar at the top. This allows you to quickly back up,
31+
share, or transfer processes as needed.
32+
![export_process_button](/images/quick-start-organize/export_process_button.png)

content/quick-start/qs-share.mdx

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
### Copy and share the process
3+
4+
In the following we will show how to quickly **download**, **share** and **copy** your created processes in different formats.
5+
Open your process in the editor and you will find a share and download button in the top right toolbar.
6+
7+
![share_toolbar](/images/quick-start-share-processes/share_toolbar.png)
8+
9+
#### Create a public link
10+
Clicking the **Share** button will provide you a popup with multiple different options. To share the process using a public link, check the box below.
11+
You can now choose which version of the process to share, display a preview and share the process using a generated link or QR code. This link will
12+
lead to a page displaying the process diagram and all its meta data.
13+
![public_link](/images/quick-start-share-processes/public_link.png)
14+
15+
#### Embed in Website
16+
You also have the option to directly embed the process on a website with an iFrame. Simply check the **Enable iFrame Embedding**
17+
box, pick a version and you can copy the created HTML element.
18+
![embed_in_website](/images/quick-start-share-processes/embed_in_website.png)
19+
20+
#### Download as PDF
21+
When downloading the process as a **PDF** you have multiple options for what to include and how to format the PDF using the checkboxes below, then
22+
simply press the download button.
23+
![download_pdf](/images/quick-start-share-processes/download_pdf.png)
24+
25+
#### Download as an image
26+
To export your process as an image, you have the option between a **PNG** or **SVG** file. You can also directly copy the image to your clipboard
27+
without having to download it first. Tick the box below the version you chose if you want to include the content inside of subprocesses
28+
that are collapsed in the diagram.
29+
![download_png](/images/quick-start-share-processes/download_png.png)
30+
31+
#### Export as BPMN in XML
32+
If you want to download the process as BPMN in **XML**, you can do so with or without including HTML and images you added to user tasks
33+
or other elements by checking the box below your chosen version
34+
![download_bpmn](/images/quick-start-share-processes/download_bpmn.png)
Lines changed: 3 additions & 0 deletions
Loading

public/images/quick-start-create-process/set_custom_property_assignedTo.png

Lines changed: 0 additions & 3 deletions
This file was deleted.

public/images/quick-start-create-process/set_custom_property_syncType.png

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 2 additions & 2 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)