Skip to content

Commit 2f4159c

Browse files
committed
Started documenting the Company level.
1 parent e4cc15b commit 2f4159c

29 files changed

+501
-175
lines changed

00-docs/src/docs/company/00-docs.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# 00-docs
2+
This provides a template or starting point for the documentation of your company project.
3+
4+
For documentation, we use [laika](https://typelevel.org/Laika/latest/table-of-content.html).
5+
6+
The following files you need to adjust:
7+
8+
```bash
9+
00-docs/src/docs
10+
| - contact.md
11+
| - instructions.md
12+
| - pattern.md
13+
| - statistics.md
14+
```
15+
16+
The following files will be created by `.helper.scala prepareDocs`:
17+
18+
```bash
19+
00-docs/src/docs
20+
| - dependencies
21+
| - helium
22+
| - catalog.md
23+
| - devStatistics.md
24+
| - index.md
25+
| - overviewDependencies.md
26+
| - release.md
27+
```
28+
So do **not adjust** them manually.

00-docs/src/docs/company/02-bpmn.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# 02-bpmn

00-docs/src/docs/company/03-api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# 03-api

00-docs/src/docs/company/03-dmn.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# 03-dmn
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# 03-simulation

00-docs/src/docs/company/03-worker.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# 03-worker

00-docs/src/docs/company/04-helper.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# 04-helper
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Development
2+
3+
This describes the development process of the company project (`mycompany-camundala/helper.scala`).
4+
5+
Make sure `helper.scala` is executable:
6+
7+
```bash
8+
cd ~/dev-mycompany/mycompany-camundala
9+
chmod +x helper.scala
10+
```
11+
12+
@:callout(info)
13+
To update this project, use `../helperCompany init` - see [Init Company].
14+
@:@
15+
16+
## publish
17+
18+
## prepareDocs
19+
20+
## publishDocs
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
laika.navigationOrder = [
3+
intro.md
4+
sbt.md
5+
00-docs.md
6+
02-bpmn.md
7+
03-api.md
8+
03-dmn.md
9+
03-simulation.md
10+
03-worker.md
11+
04-helper.md
12+
development.md
13+
postman.md
14+
]

00-docs/src/docs/company/intro.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
{%
2+
helium.site.pageNavigation.enabled = false
3+
%}
4+
5+
# Introduction
6+
7+
A Company Project handles the specific configuration for the company.
8+
9+
@:callout(info)
10+
Make sure you have [init the company](../development/initCompany.md).
11+
12+
In this process many files are generated and some are replaced.
13+
14+
Only files with the comment `DO NOT ADJUST` will be replaced.
15+
So if you add custom code, make sure to remove this comment.
16+
17+
We recommend you make a comment what you have changed,
18+
so you can easily update the file from time to time.
19+
(just add the `DO NOT ADJUST` comment again)
20+
21+
If there is no `DO NOT ADJUST` comment, you need to delete it if you want the newest version of this file.
22+
23+
Normally these files have the comment: `// This file was created with .. - to reset delete it and run the command.`.
24+
@:@
25+
26+
The layout looks similar to a BPMN project:
27+
```bash
28+
myCompany-camundala
29+
| 00-docs
30+
| 02-bpmn
31+
| 03-api
32+
| 03-dmn
33+
| 03-simulation
34+
| 03-worker
35+
| 04-helper
36+
| project
37+
| build.sbt
38+
| helper.scala
39+
40+
```
41+
42+
To setup the Company Project, follow these steps:
43+
44+
1. Open the `mycompany-camundala` directory with your IDE (I use Intellij).
45+
1. Import the sbt project. The project should compile without errors.
46+
1. **[sbt]**
47+
48+
The build tool (`project`, `build.sbt`).
49+
50+
1. **[00-docs]**
51+
52+
The company's documentation.
53+
1. **[02-bpmn]**
54+
55+
General configurations and code for the _BPMN DSL_.
56+
1. **[03-api]**
57+
58+
General configurations and code for the _Api DSL_.
59+
1. **[03-dmn]**
60+
61+
General configurations and code for the _DmnTester DSL_.
62+
1. **[03-simulation]**
63+
64+
General configurations and code for the _Simulation DSL_.
65+
1. **[03-worker]**
66+
67+
General configurations and code for the _Worker DSL_.
68+
1. **[04-helper]**
69+
70+
General configurations and code for the development process of the projects,
71+
Including the Company project.
72+
73+
1. **[Development]**
74+
75+
The `helper.scala` script supports the development process.

0 commit comments

Comments
 (0)