Skip to content

Commit

Permalink
docs: Add comparision between local Capella and Collaboration Manager
Browse files Browse the repository at this point in the history
  • Loading branch information
MoritzWeber0 committed Sep 21, 2024
1 parent 6828e3a commit 153a3f1
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 1 deletion.
63 changes: 63 additions & 0 deletions docs/docs/user/tools/capella/local-installation-vs-collab-mgr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<!--
~ SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
~ SPDX-License-Identifier: Apache-2.0
-->

# Difference between a local installation and the Capella Collaboration Manager

You may have though about why you should use the Capella Collaboration Manager
and not just a local Capella installation. It depends on a variety of factors,
so here is a decision help:

<table markdown="span">
<tr>
<th style="width:20%"></th>
<th style="width:40%">Local Capella Installation</th>
<th style="width:40%">Capella Collaboration Manager</th>
</tr>
<tr>
<td><b>Differences between operating systems</b></td>
<td>When the team uses different operating systems or dependencies, there may be small differences in the Capella behaviour. Bugs have to be collected and reported for each OS individully. In addition, it's important that all users use the same font, otherwise digrams will change on each save when a new font is applied. Diagrams might look different on different devices.</td>
<td>All sessions run on Linux in a Docker container with exactly the same dependencies. Bugs are easier to reproduce.</td>
</tr>
<tr>
<td><b>Configuration</b></td>
<td>Manual configuration by users. Some configuration options have to be aligned in the team.</td>
<td>Pre-defined configuration according to best-practises and experience. Users may deviate from the central configuration via modifications in their personal workspace.</td>
</tr>
<tr>
<td><b>Performance</b></td>
<td>Native Capella performance, no latency in local projects.</td>
<td>Performance depends on the internet connection and latency.</td>
</tr>
<tr>
<td><b>Backups</b></td>
<td>Unless saved on a remote server like TeamForCapella or Git, changes have to be backed up manually.</td>
<td>Workspaces can be backed up regularly (this service might not be enabled for all environments).</td>
</tr>
<tr>
<td><b>Offline working</b></td>
<td>Offline working possible with local models or with the Git workflow. Not possible with TeamForCapella.</td>
<td>Access via browser with active internet connection. Working offline is not possible at the moment.</td>
</tr>
<tr>
<td><b>Installation effort</b></td>
<td>Software, plugins, dependencies and dropins have to be installed and updated manually.</td>
<td>Everything is installed centrally and managed by the System Administrators.</td>
</tr>
<tr>
<td><b>Working together in Capella</b></td>
<td>Requires external software for screen sharing.</td>
<td>Natively integrated via Session Sharing.</td>
</tr>
<tr markdown="span">
<td><b>Task automation</b></td>
<td>Tasks can be automated using `capellambse` and `capellambse-context-diagrams` locally. Python, dependencies and packages have to be installed manually.</td>
<td>Native integration of Jupyter with the latest versions of `capellambse` and `capellambse-context-diagrams` preinstalled.</td>
</tr>
<tr markdown="span">
<td><b>Support effort</b></td>
<td>High effort to support installation on many different devices. Workspaces and logs are not accessible centrally.</td>
<td>Central log collection and installation. For debug purposes, workspace can be accessed by System Administrators.</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion docs/docs/user/tools/capella/t4c-git-compare.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
</tr>
<tr>
<td><b>Concurrent working</b></td>
<td>Very challenging because of merge conflict potential.</td>
<td>Very challenging because of merge conflict potential, a possible workflow is described [here](./git/index.md).</td>
<td>Is possible. Diagrams are locked, no risk of merge conflicts.</td>
</tr>
<tr>
Expand Down
1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ nav:
- Introduction: user/tools/capella/introduction.md
- Update a Capella Model to a Newer Version: user/tools/capella/migration/index.md
- Co-working Methods: user/tools/capella/t4c-git-compare.md
- Local Capella vs. Collaboration Manager: user/tools/capella/local-installation-vs-collab-mgr.md
- TeamForCapella:
- Connect to a TeamForCapella Repository: user/tools/capella/teamforcapella/connect/index.md
- Import a Model from TeamForCapella: user/tools/capella/teamforcapella/import/index.md
Expand Down

0 comments on commit 153a3f1

Please sign in to comment.