Skip to content

Commit f3ad1fc

Browse files
zambrovskizambrovski
committed
add more docs
1 parent d4b9f39 commit f3ad1fc

12 files changed

Lines changed: 263 additions & 62 deletions

File tree

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
Please use one of the following templates:
22

3-
https://github.com/bpm-crafters/process-engine-api/issues/new/choose
3+
https://github.com/bpm-crafters/process-engine-api-docs/issues/new/choose

‎.github/ISSUE_TEMPLATE/1_bug_report.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,7 @@ labels: 'Type: bug'
88

99
### Steps to reproduce
1010

11-
* Library version:
12-
* JDK version:
13-
* Operating system:
14-
* Complete executable reproducer: (e.g. GitHub Repo)
15-
* Steps: (what exactly are you doing with the above reproducer?)
11+
* Docs version:
1612

1713
### Expected behaviour
1814

‎.github/ISSUE_TEMPLATE/2_feature_request.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ assignees:
99

1010
### Scenario
1111

12-
* Library version:
12+
* Docs version:
1313
* Description of your use case: (detailed description or executable reproducer, e.g. GitHub repo)
1414

1515
### Current Behaviour

‎.github/workflows/release-notes.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# Trigger the workflow on milestone events
1+
name: Milestone Closure
2+
23
on:
34
milestone:
45
types: [closed]
5-
name: Milestone Closure
6+
67
jobs:
78
create-release-notes:
89
runs-on: ubuntu-latest

‎docs/assets/img/library-components.drawio‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
<mxfile host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/26.2.15 Chrome/134.0.6998.205 Electron/35.2.1 Safari/537.36" version="26.2.15">
2+
<diagram name="Page-1" id="GKmtULYF7NSTZoNblqxI">
3+
<mxGraphModel dx="1845" dy="709" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
4+
<root>
5+
<mxCell id="0" />
6+
<mxCell id="1" parent="0" />
7+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-25" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;endArrow=block;endFill=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-7" target="QJJDSfq_JiwtMY7JYXgB-1" edge="1">
8+
<mxGeometry relative="1" as="geometry" />
9+
</mxCell>
10+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-22" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;endArrow=block;endFill=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-11" target="QJJDSfq_JiwtMY7JYXgB-1" edge="1">
11+
<mxGeometry relative="1" as="geometry" />
12+
</mxCell>
13+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-1" value="Process&lt;br&gt;Engine&lt;br&gt;API" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
14+
<mxGeometry x="-510" y="40" width="80" height="380" as="geometry" />
15+
</mxCell>
16+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-2" value="Use Case" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
17+
<mxGeometry x="-790" y="40" width="100" height="80" as="geometry" />
18+
</mxCell>
19+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-14" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-3" target="QJJDSfq_JiwtMY7JYXgB-4" edge="1">
20+
<mxGeometry relative="1" as="geometry" />
21+
</mxCell>
22+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-23" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;endArrow=block;endFill=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-3" target="QJJDSfq_JiwtMY7JYXgB-1" edge="1">
23+
<mxGeometry relative="1" as="geometry" />
24+
</mxCell>
25+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-3" value="C7 Adapter Embedded" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
26+
<mxGeometry x="-350" y="40" width="160" height="80" as="geometry" />
27+
</mxCell>
28+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-4" value="Camunda 7 Java API" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
29+
<mxGeometry x="-30" y="40" width="150" height="80" as="geometry" />
30+
</mxCell>
31+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-24" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;endArrow=block;endFill=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-5" target="QJJDSfq_JiwtMY7JYXgB-1" edge="1">
32+
<mxGeometry relative="1" as="geometry" />
33+
</mxCell>
34+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-26" value="impl" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" parent="QJJDSfq_JiwtMY7JYXgB-24" vertex="1" connectable="0">
35+
<mxGeometry x="0.6889" y="-2" relative="1" as="geometry">
36+
<mxPoint y="-13" as="offset" />
37+
</mxGeometry>
38+
</mxCell>
39+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-5" value="C7 Adapter Remote" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
40+
<mxGeometry x="-350" y="140" width="160" height="80" as="geometry" />
41+
</mxCell>
42+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-6" value="Camunda 7 REST API" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
43+
<mxGeometry x="-30" y="140" width="150" height="80" as="geometry" />
44+
</mxCell>
45+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-41" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-7" target="QJJDSfq_JiwtMY7JYXgB-10" edge="1">
46+
<mxGeometry relative="1" as="geometry" />
47+
</mxCell>
48+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-7" value="C8 Adapter" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
49+
<mxGeometry x="-350" y="240" width="160" height="80" as="geometry" />
50+
</mxCell>
51+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-8" value="Camunda 8 REST API" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
52+
<mxGeometry x="-30" y="240" width="150" height="80" as="geometry" />
53+
</mxCell>
54+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-15" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-9" target="QJJDSfq_JiwtMY7JYXgB-6" edge="1">
55+
<mxGeometry relative="1" as="geometry" />
56+
</mxCell>
57+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-19" value="REST" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" parent="QJJDSfq_JiwtMY7JYXgB-15" vertex="1" connectable="0">
58+
<mxGeometry x="-0.25" y="1" relative="1" as="geometry">
59+
<mxPoint x="1" y="1" as="offset" />
60+
</mxGeometry>
61+
</mxCell>
62+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-9" value="C7&lt;br&gt;REST&lt;br&gt;Client&lt;div&gt;Feign&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" parent="1" vertex="1">
63+
<mxGeometry x="-160" y="140" width="80" height="80" as="geometry" />
64+
</mxCell>
65+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-16" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-10" target="QJJDSfq_JiwtMY7JYXgB-8" edge="1">
66+
<mxGeometry relative="1" as="geometry" />
67+
</mxCell>
68+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-20" value="gRPC" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" parent="QJJDSfq_JiwtMY7JYXgB-16" vertex="1" connectable="0">
69+
<mxGeometry x="-0.0286" y="1" relative="1" as="geometry">
70+
<mxPoint x="-4" y="1" as="offset" />
71+
</mxGeometry>
72+
</mxCell>
73+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-10" value="Camunda 8 Client Java" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
74+
<mxGeometry x="-160" y="240" width="80" height="80" as="geometry" />
75+
</mxCell>
76+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-17" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-11" target="QJJDSfq_JiwtMY7JYXgB-12" edge="1">
77+
<mxGeometry relative="1" as="geometry" />
78+
</mxCell>
79+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-11" value="CIB7 Adapter Embedded" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
80+
<mxGeometry x="-350" y="340" width="160" height="80" as="geometry" />
81+
</mxCell>
82+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-12" value="CIB7&lt;span style=&quot;background-color: transparent; color: light-dark(rgb(0, 0, 0), rgb(255, 255, 255));&quot;&gt;&amp;nbsp;Java API&lt;/span&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
83+
<mxGeometry x="-30" y="340" width="150" height="80" as="geometry" />
84+
</mxCell>
85+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-31" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.004;exitY=0.777;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;exitPerimeter=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-13" target="QJJDSfq_JiwtMY7JYXgB-30" edge="1">
86+
<mxGeometry relative="1" as="geometry" />
87+
</mxCell>
88+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-33" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.223;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;exitPerimeter=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-13" target="QJJDSfq_JiwtMY7JYXgB-29" edge="1">
89+
<mxGeometry relative="1" as="geometry" />
90+
</mxCell>
91+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-13" value="Process&lt;br&gt;Engine&lt;br&gt;Worker" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
92+
<mxGeometry x="-630" y="240" width="80" height="180" as="geometry" />
93+
</mxCell>
94+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-28" value="Use Case" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
95+
<mxGeometry x="-790" y="140" width="100" height="80" as="geometry" />
96+
</mxCell>
97+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-29" value="Use Case" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
98+
<mxGeometry x="-790" y="240" width="100" height="80" as="geometry" />
99+
</mxCell>
100+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-30" value="Use Case" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
101+
<mxGeometry x="-790" y="340" width="100" height="80" as="geometry" />
102+
</mxCell>
103+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-34" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-28" edge="1">
104+
<mxGeometry relative="1" as="geometry">
105+
<mxPoint x="-510" y="180" as="targetPoint" />
106+
</mxGeometry>
107+
</mxCell>
108+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-37" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.105;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-2" target="QJJDSfq_JiwtMY7JYXgB-1" edge="1">
109+
<mxGeometry relative="1" as="geometry" />
110+
</mxCell>
111+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-39" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=-0.005;entryY=0.765;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-13" target="QJJDSfq_JiwtMY7JYXgB-1" edge="1">
112+
<mxGeometry relative="1" as="geometry" />
113+
</mxCell>
114+
<mxCell id="QJJDSfq_JiwtMY7JYXgB-40" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=-0.025;entryY=0.51;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" source="QJJDSfq_JiwtMY7JYXgB-5" target="QJJDSfq_JiwtMY7JYXgB-9" edge="1">
115+
<mxGeometry relative="1" as="geometry" />
116+
</mxCell>
117+
</root>
118+
</mxGraphModel>
119+
</diagram>
120+
</mxfile>

‎docs/assets/img/library-components.png‎

68.9 KB
Loading

‎docs/getting-started/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ project's `pom.xml`:
1212
```
1313

1414
This dependency provides you with the most important classes required for implementation of your system using
15-
a process engine. Here is an example how a user task can be completed:
15+
a process engine. Here is an example of how a user task can be completed:
1616

1717
```java
1818

@@ -40,7 +40,7 @@ public class CompleteUserTaskUseCase implements CompleteUserTaskInPort {
4040
```
4141

4242
As you can see, the code above doesn't contain any engine-specific code, but rather uses only code from `process-engine-api`.
43-
This means, that the resulting code is portable and the decision about the used engine doesn't influence the implementation
43+
This means that the resulting code is portable and the decision about the used engine doesn't influence the implementation
4444
of your application logic.
4545

4646
The second step depends on your target architecture and used process engine. Please check the quickstart sections of the available adapters.

‎docs/index.md‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
1-
## Why should I use this?
1+
## What is Process Engine API?
22

3-
Our experience with different process engines led us to an idea to create a vendor-independent API abstracting main capabilities of a process engine.
4-
In doing so, we followed several ideas:
3+
Our experience with different process engines led us to an idea to create a vendor-independent API abstracting the main capabilities of a process engine.
54

6-
* The API must be asynchronous.
7-
* The user should not make assumptions about the implementations of the API to stay portable if those are exchanged.
8-
* The API offers the minimal set of capabilities instead of support all possible vendor specific product features, which have nothing to do with process orchestration.
9-
* Different aspects of process engine integration are solved using different independent APIs.
10-
* The API is command based (you pass immutable commands indicating your intent).
11-
* For interaction with your software, the API uses subscriptions.
12-
* The vendor-adapters implementing APIs are drop-ins to your application classpath and your application should not depend on it (rather you can configure those independently)
5+
In doing so, we followed several principles:
6+
7+
* The API must be **asynchronous**.
8+
* The user should not make **assumptions about the implementations** of the API to stay portable if those are exchanged.
9+
* The API offers the **minimal common** set of capabilities instead of supporting all possible vendor-specific product features, unrelated to process orchestration.
10+
* Different aspects of process engine integration are solved using **different independent APIs**.
11+
* The API is **command-based** (you pass immutable commands indicating your intent).
12+
* For interaction with your software, the API uses **subscriptions**.
13+
* The vendor-adapters implementing APIs are **drop-ins** to your application classpath, and your application should not depend on them (rather you can configure those independently).
14+
15+
## What process engines are already supported?
1316

1417
Having all this in mind, we created a Process Engine API with several adapters which are ready to use in your next process application. In particular,
1518
you can use Process Engine API in your application and configure the adapter to use it with the following process engines / operation modes:
1619

1720
* Camunda Platform 7 Embedded (Spring Boot)
1821
* Camunda Platform 7 Remote (connected via REST)
19-
* Camunda Platform 8 Self Managed
20-
* Camunda Platform 8 SaaS / Cloud
22+
* Camunda Platform 8
2123
* CIB Seven Embedded (Spring Boot)
2224

23-
In doing so, you might start your application using one engine / mode and easily migrate to the other later on, by changing a dependency and providing some
25+
In doing so, you might start your application using one engine / mode and migrate to the other later on, by changing a dependency and providing some
2426
additional configuration.
2527

2628
Sounds interesting to you? Try it out and provide us with some feedback...

0 commit comments

Comments
 (0)