-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(user): Add quick comparision of Capella co-working methods
The co-working methods TeamForCapella and Git are compared in a table.
- Loading branch information
1 parent
bba492a
commit 42040a9
Showing
2 changed files
with
89 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
<!-- | ||
~ SPDX-FileCopyrightText: Copyright DB Netz AG and the capella-collab-manager contributors | ||
~ SPDX-License-Identifier: Apache-2.0 | ||
--> | ||
|
||
# Ways of co-working on a Capella project | ||
|
||
## Quick comparision | ||
|
||
<table markdown="1"> | ||
<tr> | ||
<th></th> | ||
<th>Git</th> | ||
<th>TeamForCapella</th> | ||
</tr> | ||
<tr> | ||
<td><b>Multiple workstreams</b></td> | ||
<td>Different workstreams available via branches</td> | ||
<td>Not recommended, only possible via different repositories</td> | ||
</tr> | ||
<tr> | ||
<td><b>Concurrent working</b></td> | ||
<td>Very challenging because of merge conflict potential.</td> | ||
<td>Is possible. Diagrams are locked, no risk of merge conflicts.</td> | ||
</tr> | ||
<tr> | ||
<td><b>Merge conflicts</b></td> | ||
<td>Resolution of merge conflicts can be challenging.</td> | ||
<td>No merge conflicts when one workstream is used. For multiple workstreams, the resolution of merge conflicts can be challenging.</td> | ||
</tr> | ||
<tr markdown="1"> | ||
<!-- This formatting is required, otherwise mkdocs breaks --> | ||
<td><b>License</b></td> | ||
<td markdown="1">No license needed[^1]</td> | ||
<td markdown="1">TeamForCapella license required[^2]</td> | ||
</tr> | ||
<tr markdown="1"> | ||
<td><b>Complexity</b></td> | ||
<td markdown="1">Git knowledge is required[^3]</td> | ||
<td>Easy to use</td> | ||
</tr> | ||
<tr> | ||
<td><b>Stability</b></td> | ||
<td>Very stable solution as changes are initially saved locally. Temporary server downtimes can also be bridged.</td> | ||
<td>Changes may be lost if the server becomes unavailable during work.</td> | ||
</tr> | ||
<tr> | ||
<td><b>Potential of data loss</b></td> | ||
<td>Changes are backed up after each push (more regularly).</td> | ||
<td>Changes are backed up on a nightly basis.</td> | ||
</tr> | ||
<tr> | ||
<td><b>Automation</b></td> | ||
<td>Possible via CI/CD in the Git repository.</td> | ||
<td>Possible via TeamForCapella → Git synchronisation (runs on a nightly basis).</td> | ||
</tr> | ||
<tr markdown="1"> | ||
<td><b>Change control</b></td> | ||
<td markdown="1">Reviews are possible via merge requests[^4]</td> | ||
<td>Change control is nearly impossible, no barriers.</td> | ||
</tr> | ||
<tr> | ||
<td><b>Release tagging</b></td> | ||
<td>Directly possible via tags in Git.</td> | ||
<td>Possible via TeamForCapella → Git synchronisation (Releases are stored as tags in the Git repository).</td> | ||
</tr> | ||
</table> | ||
|
||
[^1]: | ||
You can use any standardized Git server. Depending on the server used, | ||
licenses for the Git server may be required. | ||
|
||
[^2]: | ||
You need a valid TeamForCapella license and TeamForCapella server installed | ||
and integrated in the Collaboration Manager. | ||
|
||
[^3]: | ||
For the basic workflow, a simple Git knowledge that includes commit, pull | ||
and push is sufficient. However, it is necessary to have at least one Git | ||
expert in the project to deal with potential merge conflicts and unexpected | ||
situations. | ||
|
||
[^4]: | ||
To review changes, the Eclipse EMF diff/merge tool can be used. However, in | ||
practice this proves to be too time-consuming, as many changes become | ||
confusing very quickly. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters