Skip to content

Commit

Permalink
docs(user): Add quick comparision of Capella co-working methods
Browse files Browse the repository at this point in the history
The co-working methods TeamForCapella and Git are compared in a table.
  • Loading branch information
MoritzWeber0 committed Sep 15, 2023
1 parent bba492a commit 86a0bf5
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 0 deletions.
77 changes: 77 additions & 0 deletions docs/user/docs/settings/tools/capella/t4c-git-compare.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<!--
~ 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>
<td><b>Complexity</b></td>
<td>High complexity, Git knowledge is required.</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 &rarr; Git synchronisation (runs on a nightly basis).</td>
</tr>
<tr>
<td><b>Change control</b></td>
<td>Reviews are possible via merge requests.</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 &rarr; 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 changes: 3 additions & 0 deletions docs/user/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ nav:
- General: settings/tools/index.md
- pure::variants: settings/tools/pure_variants.md
- Capella:
- Co-working methods: settings/tools/capella/t4c-git-compare.md
- TeamForCapella:
- Import a model from TeamForCapella: settings/tools/capella/teamforcapella/import/import-from-t4c.md
- Export a model to TeamForCapella: settings/tools/capella/teamforcapella/export/export-to-t4c.md
Expand All @@ -73,9 +74,11 @@ markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.extra
- abbr
- pymdownx.snippets
- attr_list
- footnotes
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
Expand Down

0 comments on commit 86a0bf5

Please sign in to comment.