diff --git a/docs/docs/admin/alerts/create.md b/docs/docs/admin/alerts/create.md index 155ee213f..84fb9c104 100644 --- a/docs/docs/admin/alerts/create.md +++ b/docs/docs/admin/alerts/create.md @@ -6,33 +6,36 @@ Alerts can be used to inform users about changes, news or maintenance work. The alerts are displayed to each user. - - -1. Navigate to `Menu` → `Settings` -2. Fill in all required fields in the `Create an alert` form. +1. Navigate to `Menu` → `Settings` +2. Fill in all required fields in the `Create an alert` form. ![Create an alert](create.png) !!! Question "What does the alert level mean?" - The alert level specifies the background color of the alert. You can - choose one of the following options:
- :material-checkbox-blank-circle:{ style="color: #004085 " } `primary`
- :material-checkbox-blank-circle:{ style="color: #383d41 " } `secondary`
- :material-checkbox-blank-circle:{ style="color: #155724 " } `success`
- :material-checkbox-blank-circle:{ style="color: #721c24 " } `danger`
- :material-checkbox-blank-circle:{ style="color: #fff3cd " } `warning`
- :material-checkbox-blank-circle:{ style="color: #d1ecf1 " } `info`
+ + The alert level specifies + the background color of the alert. You can choose one of the following + options:
+ + :material-checkbox-blank-circle:{ style="color: #004085 " } `primary`
+ :material-checkbox-blank-circle:{ style="color: #383d41 " } `secondary`
+ :material-checkbox-blank-circle:{ style="color: #155724 " } `success`
+ :material-checkbox-blank-circle:{ style="color: #721c24 " } `danger`
+ :material-checkbox-blank-circle:{ style="color: #fff3cd " } `warning`
+ :material-checkbox-blank-circle:{ style="color: #d1ecf1 " } `info`
!!! Question "Which scopes are available?" - Currently, there is only one scope. Please enter `t4c` in the scope field. - !!! Hint - Simple HTML tags can be used in the alerts description. - For example, a link can be created with: + Currently, there is only one scope. + Please enter `t4c` in the scope field. + + !!! hint + + Simple HTML tags can be used in the alerts description. For + example, a link can be created with: ``` html Link description ``` -3. The alert is now created and is displayed to all users: - ![Success alert](success_alert.png) - +3. The alert is now created and is displayed to all users: + ![Success alert](success_alert.png) diff --git a/docs/docs/admin/installation.md b/docs/docs/admin/installation.md index 74534228e..6b71b012d 100644 --- a/docs/docs/admin/installation.md +++ b/docs/docs/admin/installation.md @@ -125,15 +125,17 @@ overview reasons, they are separated: - Pipeline jobs for nightly TeamForCapella to Git synchronisation - Session containers (Capella, Papyrus, Juypter, pure::variants) - -1. Create the two required namespaces: +--- + +1. Create the two required namespaces: ```zsh kubectl create namespace collab-manager # If you use another name, please update the following commands and use your namespace name. kubectl create namespace collab-sessions # If you use another name, please update the `values.yaml` accordingly. ``` -2. Set the `collab-manager` as default namespace in the default context (optional): +1. Set the `collab-manager` as default namespace in the default context + (optional): ```zsh kubectl config set-context --current --namespace=collab-manager @@ -238,32 +240,31 @@ If a value is false, check the backend logs for more information. ## Step 10: Add TeamForCapella Support - !!! info "TeamForCapella server required" + The setup of the TeamForCapella server and license server itself will not be part of this tutorial. To process, you'll need to have a running and reachable TeamForCapella server. - !!! info "Container registry required" + For the TeamForCapella support, you'll need to build own Docker images. In order to use this in the cluster, an external or internal container registry is required. - -1. Install [GNU make](https://www.gnu.org/software/make/manual/make.html) >= - 3.82 -1. Navigate to the root of the capella-collab-manager repository. -1. Clone the capella-dockerimages repository: - ```zsh - git clone https://github.com/DSD-DBS/capella-dockerimages - ``` -1. Prepare the `capella/base` and `t4c/client/base` images according to the - Capella Docker images documentation (Only the preparation section is - needed): +1. Install [GNU make](https://www.gnu.org/software/make/manual/make.html) >= + 3.82 +1. Navigate to the root of the capella-collab-manager repository. +1. Clone the capella-dockerimages repository: + ```zsh + git clone https://github.com/DSD-DBS/capella-dockerimages + ``` +1. Prepare the `capella/base` and `t4c/client/base` images according to the + Capella Docker images documentation (Only the preparation section is + needed): - [`capella/base`](https://dsd-dbs.github.io/capella-dockerimages/capella/base/#preparation) - [`t4c/client/base`](https://dsd-dbs.github.io/capella-dockerimages/capella/t4c/base/#preparation) -1. Set the following environment variables: +1. Set the following environment variables: ```zsh export PUSH_IMAGES=1 # Auto-push images to the container registry after build @@ -273,12 +274,12 @@ If a value is false, check the backend logs for more information. export CAPELLA_DROPINS="" # Command separated list of dropins ``` -1. Then, build the `t4c/client/remote` images (the one that we'll use in the - Collaboration Manager): +1. Then, build the `t4c/client/remote` images (the one that we'll use in the + Collaboration Manager): ```zsh make t4c/client/remote ``` -1. In the Collaboration Manager UI, change the docker image of the tool to - `/t4c/client/remote:-latest` +1. In the Collaboration Manager UI, change the docker image of the tool to + `/t4c/client/remote:-latest` diff --git a/docs/docs/admin/settings/model-sources/git.md b/docs/docs/admin/settings/model-sources/git.md index 0af175f97..7a4d00048 100644 --- a/docs/docs/admin/settings/model-sources/git.md +++ b/docs/docs/admin/settings/model-sources/git.md @@ -21,19 +21,31 @@ Gitlab, are not available. 1. You can see all existing instances (if any). To add a new integration, please use the form below "Add new integration". You have to enter the following information: - - 1. **Git Type** - - **General**: Works with every [Git server](https://git-scm.com/book/en/v2/Git-on-the-Server-Setting-Up-the-Server) that supports the Git protocol. Features like the diagram cache are not available. - - **Gitlab**: Only works with [Gitlab](https://about.gitlab.com/) instances (self-hosted / SaaS). With Gitlab, the diagram cache integration can be used. - - **Github**: Works with the public [Github](https://github.com/) instance. With Github, the diagram cache integration can be used. - 1. **Name**: Any name to identify the instance - 1. **Instance base URL**: The base URL of the instance, e.g., `https://gitlab.com`. For more information, see [Matching between models and instances](#matching-between-models-and-instances) - 1. **API URL**: - - **Gitlab**: The API URL to the [Gitlab REST API](https://docs.gitlab.com/ee/api/rest/). In most of the cases: `{base_url}/api/v4`, e.g., `https://gitlab.com/api/v4`. - - **Github**: The API URL to the [Github REST API](https://docs.github.com/en/rest?apiVersion=2022-11-28). The url is `https://api.github.com`. - - + + 1. **Git Type** + - **General**: Works with every + [Git server](https://git-scm.com/book/en/v2/Git-on-the-Server-Setting-Up-the-Server) + that supports the Git protocol. Features like the diagram cache are not + available. + - **Gitlab**: Only works with [Gitlab](https://about.gitlab.com/) + instances (self-hosted / SaaS). With Gitlab, the diagram cache + integration can be used. + - **Github**: Works with the public [Github](https://github.com/) + instance. With Github, the diagram cache integration can be used. + 1. **Name**: Any name to identify the instance + 1. **Instance base URL**: The base URL of the instance, e.g., + `https://gitlab.com`. For more information, see + [Matching between models and instances](#matching-between-models-and-instances) + 1. **API URL**: + - **Gitlab**: The API URL to the + [Gitlab REST API](https://docs.gitlab.com/ee/api/rest/). In most of the + cases: `{base_url}/api/v4`, e.g., `https://gitlab.com/api/v4`. + - **Github**: The API URL to the + [Github REST API](https://docs.github.com/en/rest?apiVersion=2022-11-28). + The url is `https://api.github.com`. + !!! warning + New repositories have to match at least one instance. Otherwise, they can not be added as model source to models. diff --git a/docs/docs/admin/settings/model-sources/t4c.md b/docs/docs/admin/settings/model-sources/t4c.md index 09b3add7a..99b9a4329 100644 --- a/docs/docs/admin/settings/model-sources/t4c.md +++ b/docs/docs/admin/settings/model-sources/t4c.md @@ -8,21 +8,22 @@ ## Define a T4C Instance 1. Please navigate to `Menu` > `Settings` -1. Select `T4C` bewlow `Model sources` +1. Select `T4C` below `Model sources` 1. You can see all existing instances (if any). To add a new instance, click on the "Add an instance" card. You have to enter the following information: - + 1. **Name**: Any name to identify the instance 1. **Capella version**: Capella version that corresponds to the instance 1. **License configuration**: License key of your license server 1. **Protocol**: Protocol that should be used to communicate between - capella sessions and the T4C server + capella sessions and the T4C server 1. **Host**: Hostname of the T4C server - 1. **Port**, **CDO Port**, and **HTTP Port** Corresponding ports of your server + 1. **Port**, **CDO Port**, and **HTTP Port** Corresponding ports of your + server 1. **License server API**: License server API url 1. **REST API**: REST API URL of the T4C server - 1. **Username**: Username with access to the REST API, required for communication - with the REST API + 1. **Username**: Username with access to the REST API, required for + communication with the REST API 1. **Password**: Password corresponding to username ## Archive a T4C Instance diff --git a/docs/docs/admin/settings/tools/pure_variants.md b/docs/docs/admin/settings/tools/pure_variants.md index 0f9d2e983..c18e56ad9 100644 --- a/docs/docs/admin/settings/tools/pure_variants.md +++ b/docs/docs/admin/settings/tools/pure_variants.md @@ -5,8 +5,8 @@ # `pure::variants` Integration - !!! info + The `pure::variants` integration can be used to: - Use pure::variants in a browser @@ -15,8 +15,8 @@ ## Setup of `pure::variants` Integration - !!! warning + The setup can only be performed by administrators. If a user wants to get access, please refer to [Get access to the `pure::variants` license as user](#get-access-to-the-purevariants-license-as-user) ### Set License Server URL and Upload `license.lic` diff --git a/docs/docs/admin/teamforcapella/migration.md b/docs/docs/admin/teamforcapella/migration.md index 342d7f602..b0ba1f142 100644 --- a/docs/docs/admin/teamforcapella/migration.md +++ b/docs/docs/admin/teamforcapella/migration.md @@ -5,30 +5,30 @@ # How to Update a Capella Model to a Higher Version (in TeamForCapella) - !!! warning + Please create backups (e.g., in a Git repository) before you start the update process. A downgrade of Capella models is not possible. -1. Open a new persistent session with the old Capella version. -1. Import the model from the TeamForCapella server via the Import wizard from - TeamForCapella into your local workspace: - [Import a model from TeamForCapella](../../user/tools/capella/teamforcapella/import/index.md) -1. Terminate the session. -1. Remove existing backups from TeamForCapella: - [Remove a (nightly) backup](../../user/projects/models/backups/remove.md) -1. Add a new repository in the TeamForCapella settings: - [Add a new TeamForCapella repository](./repository-management/index.md#add-a-new-teamforcapella-repository) -1. Unlink the old TeamForCapella repository (old Capella version) from your - model: - [Unlink a TeamForCapella repository](./project-integration/index.md#unlink-a-teamforcapella-repository-from-a-project-model) -1. Link the new TeamForCapella repository (new Capella version) to your model: - [Link a TeamForCapella repository](./project-integration/index.md#link-a-teamforcapella-repository-to-a-project-model) -1. Update the model version to the newer Capella version: - [Change model metadata](../../user/projects/models/metadata.md) -1. Create a new session with the new Capella version. -1. In your persistent workspace, execute the following steps: - +1. Open a new persistent session with the old Capella version. +1. Import the model from the TeamForCapella server via the Import wizard from + TeamForCapella into your local workspace: + [Import a model from TeamForCapella](../../user/tools/capella/teamforcapella/import/index.md) +1. Terminate the session. +1. Remove existing backups from TeamForCapella: + [Remove a (nightly) backup](../../user/projects/models/backups/remove.md) +1. Add a new repository in the TeamForCapella settings: + [Add a new TeamForCapella repository](./repository-management/index.md#add-a-new-teamforcapella-repository) +1. Unlink the old TeamForCapella repository (old Capella version) from your + model: + [Unlink a TeamForCapella repository](./project-integration/index.md#unlink-a-teamforcapella-repository-from-a-project-model) +1. Link the new TeamForCapella repository (new Capella version) to your model: + [Link a TeamForCapella repository](./project-integration/index.md#link-a-teamforcapella-repository-to-a-project-model) +1. Update the model version to the newer Capella version: + [Change model metadata](../../user/projects/models/metadata.md) +1. Create a new session with the new Capella version. +1. In your persistent workspace, execute the following steps: + 1. Right click on the model in your workspace. 1. Select `Migration` and `Migrate Project toward current version` ![Migrate Capella model](../../user/tools/capella/migration/migrate-capella-model.png) @@ -36,8 +36,8 @@ on the old TeamForCapella server. ![Disable backup option](../../user/tools/capella/migration/backup-migration.png) -1. Export the model to the new TeamForCapella server via the Export wizzard - from TeamForCapella: - [Export a model to TeamForCapella](../../user/tools/capella/teamforcapella/export/index.md) -1. Recreate the backup pipeline: - [Set up a TeamForCapella backup](../../user/projects/models/backups/setup.md) +1. Export the model to the new TeamForCapella server via the Export wizzard + from TeamForCapella: + [Export a model to TeamForCapella](../../user/tools/capella/teamforcapella/export/index.md) +1. Recreate the backup pipeline: + [Set up a TeamForCapella backup](../../user/projects/models/backups/setup.md) diff --git a/docs/docs/admin/teamforcapella/project-integration/index.md b/docs/docs/admin/teamforcapella/project-integration/index.md index cf3bf56ad..8d1e5bc63 100644 --- a/docs/docs/admin/teamforcapella/project-integration/index.md +++ b/docs/docs/admin/teamforcapella/project-integration/index.md @@ -11,25 +11,27 @@ sources button for the model.
## Link a TeamForCapella Repository to a Project Model -1. Click on `Use existing repository` in the `T4C Models` section. -1. Select the TeamForCapella instance, the repository and enter a project name. - It is recommended to have the same name for the repository and the Capella - project. -1. Click on `Save reference` -1. The TeamForCapella reference should appear in the list of `T4C Models`. - +1. Click on `Use existing repository` in the `T4C Models` section. +1. Select the TeamForCapella instance, the repository and enter a project + name. It is recommended to have the same name for the repository and the + Capella project. +1. Click on `Save reference` +1. The TeamForCapella reference should appear in the list of `T4C Models`. + !!! info + Users, who are members of the project, will get access to the repository during the next session start. The session token will not be updated for existing/open sessions. ## Unlink a TeamForCapella Repository from a Project Model -1. Select the TeamForCapella reference/integration from the list. -1. Click on `Unlink` and confirm. -1. The TeamForCapella integration should not be listed anymore. - +1. Select the TeamForCapella reference/integration from the list. +1. Click on `Unlink` and confirm. +1. The TeamForCapella integration should not be listed anymore. + !!! info - Users, who are members of the project, - don't have to access to the repository anymore. - In addition, it is not listed in the dropdown menu anymore. + + Users, who are members of the project, + don't have to access to the repository anymore. + In addition, it is not listed in the dropdown menu anymore. diff --git a/docs/docs/admin/teamforcapella/project-management/index.md b/docs/docs/admin/teamforcapella/project-management/index.md index f34ccc5e1..2cba410ce 100644 --- a/docs/docs/admin/teamforcapella/project-management/index.md +++ b/docs/docs/admin/teamforcapella/project-management/index.md @@ -23,7 +23,6 @@ guide. ## Delete a TeamForCapella Project - 1. Open a persistent Capella session and connect to it. 1. Enable the TeamForCapella administration capability:
`Window` > `Preferences` > `General` > `Capabilities`: @@ -35,19 +34,20 @@ guide. 1. Enter the connection string for the TeamForCapella server. There two ways to find the correct one. Make sure that the host is prefixed with `tcp://`. - 1. Global administrators can navigate to `Menu` > `Settings` > - `Model sources` > `TeamForCapella` > Select the instance > `Host`. - 1. Project managers can use the TeamForCapella connection flow described in - the [Connect to a TeamForCapella repository](../../../user/tools/capella/teamforcapella/export/index.md) - guide. In the `Connect to Shared Project` dialog, select the repository, - expand "Connection information" and copy the "Repository host". - ![Find out T4C server host](./find-out-repository-host.png) + 1. Global administrators can navigate to `Menu` > `Settings` > + `Model sources` > `TeamForCapella` > Select the instance > `Host`. + 1. Project managers can use the TeamForCapella connection flow described in + the + [Connect to a TeamForCapella repository](../../../user/tools/capella/teamforcapella/export/index.md) + guide. In the `Connect to Shared Project` dialog, select the repository, + expand "Connection information" and copy the "Repository host". + ![Find out T4C server host](./find-out-repository-host.png) 1. Enter the repository name and confirm with "Ok". - ![Open CDO session](./open-cdo-session.png) + ![Open CDO session](./open-cdo-session.png) 1. Open a CDO session transaction: - ![Open a CDO transaction](./open-cdo-transaction.png) -1. Expand the transaction, select the project to delete, right click, and select "Delete...": - ![Delete a T4C project](./delete-t4c-project.png) + ![Open a CDO transaction](./open-cdo-transaction.png) +1. Expand the transaction, select the project to delete, right click, and + select "Delete...": ![Delete a T4C project](./delete-t4c-project.png) 1. Confirm the deletion with "Ok" and wait until the transaction is finished. This can take a few minutes. diff --git a/docs/docs/admin/teamforcapella/repository-management/index.md b/docs/docs/admin/teamforcapella/repository-management/index.md index 77def8cb7..62faa5809 100644 --- a/docs/docs/admin/teamforcapella/repository-management/index.md +++ b/docs/docs/admin/teamforcapella/repository-management/index.md @@ -25,8 +25,8 @@ all existing repositories with their status. ## Remove a TeamForCapella Repository - !!! danger + Deleted TeamForCapella repositories can not be restored. If you don't have backups, the models in the repository are not recoverable! diff --git a/docs/docs/admin/uninstallation.md b/docs/docs/admin/uninstallation.md index 12f682677..fd3454850 100644 --- a/docs/docs/admin/uninstallation.md +++ b/docs/docs/admin/uninstallation.md @@ -10,11 +10,10 @@ improve, please share them with us. Either privately via or via a [Github issue](https://github.com/DSD-DBS/capella-collab-manager/issues). - -1. If you want to uninstall the management portal, you can run the following - comment: +1. If you want to uninstall the management portal, you can run the following + comment: - ```sh + ```zsh helm uninstall -n helm ``` @@ -24,8 +23,8 @@ or via a kubectl delete namespace ``` -1. The previous command doesn't clean the sessions namespace. Please clean it - manually by running (this does also remove all persistent workspaces!): +1. The previous command doesn't clean the sessions namespace. Please clean it + manually by running (this does also remove all persistent workspaces!): ```zsh kubectl -n delete all --all diff --git a/docs/docs/user/projects/add-user/index.md b/docs/docs/user/projects/add-user/index.md index 055f18edc..4b5c5f4bc 100644 --- a/docs/docs/user/projects/add-user/index.md +++ b/docs/docs/user/projects/add-user/index.md @@ -3,8 +3,8 @@ ~ SPDX-License-Identifier: Apache-2.0 --> - !!! warning + You need to have the Administrator or Project Lead role for a project to perform the following steps. @@ -28,28 +28,26 @@ ## Modify Role or Permissions of User - - -1. Select your project in the project overview. -1. On the right side you should now see user management options: +1. Select your project in the project overview. +1. On the right side you should now see user management options: ![User management](./manage-users.png) -1. Select the user you want do modify:
+1. Select the user you want do modify:
![User modification](./modify-user.png) - You can select from the following options: + You can select from the following options: - - Remove a user from the project - - Set role of the user to [project lead](../../projects/roles.md) or - [user](../../projects/roles.md) - - Set permission of the user to [read/write](../../sessions/types/index.md) or - [read-only](../../sessions/types/index.md) + - Remove a user from the project + - Set role of the user to [project lead](../../projects/roles.md) or + [user](../../projects/roles.md) + - Set permission of the user to [read/write](../../sessions/types/index.md) + or [read-only](../../sessions/types/index.md) !!! info - You can not modify your own user or any administrator! + + You can not modify your own user or any administrator! !!! info - Open sessions are not terminated automatically on permission change. - The TeamForCapella access is only revoked - when the user's last session is terminated. - + Open sessions are not terminated automatically on permission change. + The TeamForCapella access is only revoked + when the user's last session is terminated. diff --git a/docs/docs/user/projects/models/backups/remove.md b/docs/docs/user/projects/models/backups/remove.md index b752ea84d..2613b6e8f 100644 --- a/docs/docs/user/projects/models/backups/remove.md +++ b/docs/docs/user/projects/models/backups/remove.md @@ -5,8 +5,8 @@ # Remove a (Nightly) Backup - !!! warning + Only administrators and project leads can remove pipelines. 1. Select the project in the `Projects` overview. diff --git a/docs/docs/user/projects/models/backups/setup.md b/docs/docs/user/projects/models/backups/setup.md index 03aed93d8..f8b2b7f18 100644 --- a/docs/docs/user/projects/models/backups/setup.md +++ b/docs/docs/user/projects/models/backups/setup.md @@ -5,13 +5,13 @@ # Set up a Backup for a TeamForCapella Model - !!! warning + You need to have the Administrator or Project Lead role for a project to perform the following steps. - !!! danger + Models are not automatically backed up! Please make sure to set up a nightly backup for important content. @@ -19,30 +19,28 @@ We offer a feature to create a backup from any TeamForCapella repository to any Git repository. These can be triggered manually and can be executed nightly at around 3pm. - - -1. Navigate to `Projects` -1. Select the relevant project -1. Make sure that you have added at least one TeamForCapella model (source) and - at least one Git repository to the model (destination) -1. In the model overview, select the `Synchronize`-button +1. Navigate to `Projects` +1. Select the relevant project +1. Make sure that you have added at least one TeamForCapella model (source) + and at least one Git repository to the model (destination) +1. In the model overview, select the `Synchronize`-button ![Model overview](./model-overview.png) -1. You can see a list of all registered backup pipelines. - In our case, there is not registered backup pipeline yet. +1. You can see a list of all registered backup pipelines. In our case, there + is not registered backup pipeline yet. ![Backup pipeline](./backups-overview.png) -1. Click on the `Plus`-icon on the top right and select the corresponding configuration. - You have to select a Git model (source) and a T4C model (destination). +1. Click on the `Plus`-icon on the top right and select the corresponding + configuration. You have to select a Git model (source) and a T4C model + (destination). ![Create a backup pipeline](./create-pipeline.png) - !!! Warning - If you choose the `Include commit history`-option, backups are resource-intensive - and each backup can take up to 5 hours depending on the size! + !!! warning -1. Confirm your selection with the `Create` button. + If you choose the `Include commit history`-option, backups are resource-intensive + and each backup can take up to 5 hours depending on the size! - +1. Confirm your selection with the `Create` button. diff --git a/docs/docs/user/projects/models/backups/trigger.md b/docs/docs/user/projects/models/backups/trigger.md index 63f994301..778574a9e 100644 --- a/docs/docs/user/projects/models/backups/trigger.md +++ b/docs/docs/user/projects/models/backups/trigger.md @@ -3,8 +3,8 @@ ~ SPDX-License-Identifier: Apache-2.0 --> - !!! warning + To perform the following steps, you need at least one existing configured backup. You can trigger backups at any time. diff --git a/docs/docs/user/projects/models/complexity_badge.md b/docs/docs/user/projects/models/complexity_badge.md index 18fabe116..36740eba0 100644 --- a/docs/docs/user/projects/models/complexity_badge.md +++ b/docs/docs/user/projects/models/complexity_badge.md @@ -21,14 +21,14 @@ 1. Link a Git repository to the model, for which you'd like to see the model complexity badge. - !!! info - If the Github repository is public, no token is required for the model complexity badge. - For private Github repositories and for Gitlab repositories the model complexity badge integration uses the credentials, - which are assigned during linking the Git repository. - - Gitlab: Limit the scope of the used token, only scope `read_api` is required. - - Github: If you are using a fine-grained personal access token, add the repository permission for the scope "content" with access `Read-only`. + If the Github repository is public, no token is required for the model complexity badge. + For private Github repositories and for Gitlab repositories the model complexity badge integration uses the credentials, + which are assigned during linking the Git repository. + + - Gitlab: Limit the scope of the used token, only scope `read_api` is required. + - Github: If you are using a fine-grained personal access token, add the repository permission for the scope "content" with access `Read-only`. 1. Follow the CI template instructions diff --git a/docs/docs/user/projects/models/create.md b/docs/docs/user/projects/models/create.md index d2e6909cc..82078f22f 100644 --- a/docs/docs/user/projects/models/create.md +++ b/docs/docs/user/projects/models/create.md @@ -52,46 +52,45 @@ reachable from inside your environment. You have to enter the following information: - - -1. **Instance**: If your environment restricts the usage of Git instances, you - have to select your instance here. Otherwise, you can continue with the next - step. -1. **URL**: Please enter the URL of your Git repository here. All URLs accepted - by the [`git clone`](https://git-scm.com/docs/git-clone) are also accepted - in the UI. +1. **Instance**: If your environment restricts the usage of Git instances, you + have to select your instance here. Otherwise, you can continue with the + next step. +1. **URL**: Please enter the URL of your Git repository here. All URLs + accepted by the [`git clone`](https://git-scm.com/docs/git-clone) are also + accepted in the UI. !!! info - If your environment restricts the usage of instances, make sure to match - the given prefix. You can also enter `Relative URLs`. In this case, - you can see the resulting URL after the `info`-icon. -1. **Username** and **password/token**: Please enter your username and token - here, which is needed to access the repository. Please note that we don't - have support for SSH authentication yet. + If your environment restricts the usage of instances, make sure to match + the given prefix. You can also enter `Relative URLs`. In this case, + you can see the resulting URL after the `info`-icon. + +1. **Username** and **password/token**: Please enter your username and token + here, which is needed to access the repository. Please note that we don't + have support for SSH authentication yet. - - For public repositories: You don't need to enter credentials. However, - backups will need credentials to be able to push to the repository. - - For private repositories: You need to enter credentials for read-only - sessions and backups. + - For public repositories: You don't need to enter credentials. However, + backups will need credentials to be able to push to the repository. + - For private repositories: You need to enter credentials for read-only + sessions and backups. !!! danger - The credentials are stored in the database, and even if not accessible - from outside, they are stored in plain text, so the password - of the user should not be used. Rather use a token. + + The credentials are stored in the database, and even if not accessible + from outside, they are stored in plain text, so the password + of the user should not be used. Rather use a token. !!! warning - The credentials should be scoped and should only work for the required - repository. When changing the repository URL and the credentials are not - changed, other project leads can gain access to different repositories - with your token. - + The credentials should be scoped and should only work for the required + repository. When changing the repository URL and the credentials are not + changed, other project leads can gain access to different repositories + with your token. ### Step 3.2 Link Existing T4C Repository - !!! warning + This step can only be executed by administrators The TeamForCapella instance has to exist before we can continue. Please select diff --git a/docs/docs/user/projects/models/diagrams/setup_diagram_cache.md b/docs/docs/user/projects/models/diagrams/setup_diagram_cache.md index d4f9b25bb..b73cf668b 100644 --- a/docs/docs/user/projects/models/diagrams/setup_diagram_cache.md +++ b/docs/docs/user/projects/models/diagrams/setup_diagram_cache.md @@ -23,23 +23,24 @@ - One pipeline in the linked Git repository should not contain more than 20 jobs. -1. To set up the diagram cache, your administrator needs to add the Git API URL - of your Gitlab or Github instance to the collab manager. More information - [here](../../../../admin/settings/model-sources/git.md). -1. Link a Git repository to the model, for which you'd like to see the diagram - cache. - +1. To set up the diagram cache, your administrator needs to add the Git API + URL of your Gitlab or Github instance to the collab manager. More + information [here](../../../../admin/settings/model-sources/git.md). +1. Link a Git repository to the model, for which you'd like to see the diagram + cache. + !!! info + The diagram cache integration uses the credentials, which are assigned when creating the Git model integration. Limit the scopes of the used token, only scope `read_api` (Gitlab) and `read-only` for the "actions" scope of the repository permissions (Github, Personal Access Token) is required. -1. Follow the CI template instructions +1. Follow the CI template instructions - - [Gitlab](https://dsd-dbs.github.io/capella-dockerimages/ci-templates/gitlab/diagram-cache/) - - [Github](https://dsd-dbs.github.io/capella-dockerimages/ci-templates/github/diagram-cache/) + - [Gitlab](https://dsd-dbs.github.io/capella-dockerimages/ci-templates/gitlab/diagram-cache/) + - [Github](https://dsd-dbs.github.io/capella-dockerimages/ci-templates/github/diagram-cache/) - to add the diagram cache pipeline to the linked repository. + to add the diagram cache pipeline to the linked repository. -1. You're ready to go. Validate if the setup works: - [View the diagrams](./view_diagram_cache.md) +1. You're ready to go. Validate if the setup works: + [View the diagrams](./view_diagram_cache.md) diff --git a/docs/docs/user/projects/models/diagrams/view_diagram_cache.md b/docs/docs/user/projects/models/diagrams/view_diagram_cache.md index 108d8d50b..34bd07c6c 100644 --- a/docs/docs/user/projects/models/diagrams/view_diagram_cache.md +++ b/docs/docs/user/projects/models/diagrams/view_diagram_cache.md @@ -5,15 +5,16 @@ # View Diagrams via the Diagram Cache Integration -1. Navigate to your project in the project overview. -2. In the model overview, select the diagrams button: - ![Button to view diagrams](./diagram_button.png){:style="width:400px"} -3. The diagram viewer should load and you should see all diagrams: - ![View diagrams](./view_diagrams.png) - +1. Navigate to your project in the project overview. +2. In the model overview, select the diagrams button: + ![Button to view diagrams](./diagram_button.png){:style="width:400px"} +3. The diagram viewer should load and you should see all diagrams: + ![View diagrams](./view_diagrams.png) + !!! note - We'll search for a successful job run in the last 20 pipelines of - the specific revision. If there is no successful pipeline (using Gitlab or Github) or your artifacts have expired (using Github), you won't be able - to see diagrams. -4. If you want to enlarge a diagram, just click on the image preview. + We'll search for a successful job run in the last 20 pipelines of + the specific revision. If there is no successful pipeline (using Gitlab or Github) or your artifacts have expired (using Github), you won't be able + to see diagrams. + +4. If you want to enlarge a diagram, just click on the image preview. diff --git a/docs/docs/user/projects/models/metadata.md b/docs/docs/user/projects/models/metadata.md index 97a8ab57c..d0c3cffef 100644 --- a/docs/docs/user/projects/models/metadata.md +++ b/docs/docs/user/projects/models/metadata.md @@ -5,8 +5,8 @@ # Update Model Metadata (Version and Nature) - !!! warning + Make sure to read the documentation about updating a [TeamForCapella model](../../../admin/teamforcapella/migration.md) or about updating a [Capella model](../../tools/capella/migration/index.md) first! diff --git a/docs/docs/user/projects/roles.md b/docs/docs/user/projects/roles.md index 942acba5b..f85778f6d 100644 --- a/docs/docs/user/projects/roles.md +++ b/docs/docs/user/projects/roles.md @@ -5,14 +5,45 @@ Projects are self-managed. There are different roles for this: - - -| Role | Permissions | -||| -| `Administrator` | :material-check-all: All permissions
:material-check: Manage TeamForCapella instances
:material-check: Manage TeamForCapella repositories
:material-check: Manage Git repositories | -| `Project lead` | :material-check: Manage users of a project
:material-check: Manage model sources
:material-check: Manage backup jobs
:material-check: `Read` and `Write` access to linked models
:material-check: Manage linked models
:material-close: Link an existing Git repository
:material-close: Link an existing TeamForCapella repository
:material-close: Delete models | -| `User`/`Read/Write` | :material-check: `Read` and `Write` access to linked models
:material-check: Access to linked TeamForCapella repositories | -| `User`/`Read only` | :material-check: `Read only` access to linked models -| `User` without project access | :material-check: Start persistent sessions - - + + + + + + + + + + + + + + + + + + + + + +
RolePermissions
`Administrator` + :material-check-all: All permissions
+ :material-check: Manage TeamForCapella instances
+ :material-check: Manage TeamForCapella repositories
+ :material-check: Manage Git repositories
`Project lead` + :material-check: Manage users of a project
+ :material-check: Manage model sources
+ :material-check: Manage backup jobs
+ :material-check: `Read` and `Write` access to linked models
+ :material-check: Manage linked models
+ :material-close: Link an existing Git repository
+ :material-close: Link an existing TeamForCapella repository
+ :material-close: Delete models +
`User`/`Read/Write` + :material-check: `Read` and `Write` access to linked models
+ :material-check: Access to linked TeamForCapella repositories +
`User`/`Read only` + :material-check: `Read only` access to linked models +
`User` without project access + :material-check: Start persistent sessions +
diff --git a/docs/docs/user/sessions/files/index.md b/docs/docs/user/sessions/files/index.md index baf56a6c3..c356d154c 100644 --- a/docs/docs/user/sessions/files/index.md +++ b/docs/docs/user/sessions/files/index.md @@ -5,64 +5,62 @@ # Browse, Upload and Download Files - - -1. Navigate to the `Session` tab. -1. On the right side, select the corresponding session. Select the persistent - session to upload files into your persistent workspace. Click the - `File Browser` button: +1. Navigate to the `Session` tab. +1. On the right side, select the corresponding session. Select the persistent + session to upload files into your persistent workspace. Click the + `File Browser` button: ![File Browser button](file-browser-button.png){:style="width:300px"} -1. Wait until the list of files has loaded. +1. Wait until the list of files has loaded. ![Upload button](upload-button.png){:style="width:300px"} !!! info + It is currently only possible to upload files with a file size of less than 30MB. For larger files we recommend a data transfer via Git. -1. Expand the directories by clicking on the directory icon (1) until you find the directories where you want to -upload your file to. Click the upload button (2) next to the directory name. +1. Expand the directories by clicking on the directory icon (1) until you find + the directories where you want to upload your file to. Click the upload + button (2) next to the directory name. ![Upload files button](upload-file-button.png){:style="width:300px"} -1. Now, select the file(s) to upload and confirm. The files to be uploaded are marked in green. +1. Now, select the file(s) to upload and confirm. The files to be uploaded are + marked in green. ![List of files to upload](files-to-upload.png){:style="width:300px"} -1. When you're ready and selected all files to upload, confirm your - selection with `Submit`. -1. The upload can take a few seconds/minutes, depending on the file size. -1. When the upload was successful, the dialog closes without error message. - - +1. When you're ready and selected all files to upload, confirm your selection + with `Submit`. +1. The upload can take a few seconds/minutes, depending on the file size. +1. When the upload was successful, the dialog closes without error message. # Download - - -1. Navigate to the `Session` tab. -1. On the right side, select the corresponding session. Select the persistent - session to download files into your persistent workspace. Click the - `File Browser` button: +1. Navigate to the `Session` tab. +1. On the right side, select the corresponding session. Select the persistent + session to download files into your persistent workspace. Click the + `File Browser` button: ![File Browser button](file-browser-button.png){:style="width:300px"} -1. Wait until the list of files has loaded. +1. Wait until the list of files has loaded. ![Download button](download-button.png){:style="width:300px"} !!! info + To download files from hidden directories, e.g., the workspace metadata, one has to expand these directories by clicking `Show hidden files` -1. Expand the directories by clicking on the directory icon (1) until you find the directories where you want to -download your file from. Click the download button (2) next to the directory name and your browser will start the download. +1. Expand the directories by clicking on the directory icon (1) until you find + the directories where you want to download your file from. Click the + download button (2) next to the directory name and your browser will start + the download. ![Download files button](download-file-button.png){:style="width:300px"} -1. You can see in your browser whether your download was successful. - - +1. You can see in your browser whether your download was successful. diff --git a/docs/docs/user/sessions/reconnect.md b/docs/docs/user/sessions/reconnect.md index 11aee45fb..c4bb6d152 100644 --- a/docs/docs/user/sessions/reconnect.md +++ b/docs/docs/user/sessions/reconnect.md @@ -3,16 +3,16 @@ ~ SPDX-License-Identifier: Apache-2.0 --> -1. Please navigate to your Active Sessions -2. Find your session and select `Reconnect`. A new window should pop up. -3. Please click on `Connect to Session`. -4. The session should appear in a new tab and Capella starts automatically. - - !!! Warning +1. Please navigate to your Active Sessions +2. Find your session and select `Connect`. A new window should pop up. +3. Please click on `Connect to Session`. +4. The session should appear in a new tab and Capella starts automatically. + + !!! warning + After reconnecting to your session, your screen may be black. It can take up to a minute until you see Capella again. -5. Please follow the instructions (depends on the workflow of your project) - +5. Please follow the instructions (depends on the workflow of your project) 1. [Git](../tools/capella/git/index.md) 2. [TeamForCapella](../tools/capella/teamforcapella/connect/index.md) diff --git a/docs/docs/user/sessions/terminate.md b/docs/docs/user/sessions/terminate.md index f5fa747dd..b47c6b9a9 100644 --- a/docs/docs/user/sessions/terminate.md +++ b/docs/docs/user/sessions/terminate.md @@ -3,25 +3,25 @@ ~ SPDX-License-Identifier: Apache-2.0 --> - - -1. Please navigate to your Active Sessions -1. Find your session, select `Terminate` and confirm your decision. -1. We'll send a signal to the used tool (e.g. Capella) to properly terminate. - The tool has 60 seconds to terminate, otherwise the process is force killed. +1. Please navigate to your Active Sessions +1. Find your session, select `Terminate` and confirm your decision. +1. We'll send a signal to the used tool (e.g. Capella) to properly terminate. + The tool has 60 seconds to terminate, otherwise the process is force + killed. !!! abstract "Technical background" - When a user clicks the `Terminate session` button, a `SIGTERM` is sent - to the container. The container reacts to the signal and terminates the - tool as well as other used programs (e.g. the `xrdp` server). After a - grace period of 60 seconds, the container recevies a `SIGKILL`, - which results in a force-kill. + + When a user clicks the `Terminate session` button, a `SIGTERM` is sent + to the container. The container reacts to the signal and terminates the + tool as well as other used programs (e.g. the `xrdp` server). After a + grace period of 60 seconds, the container recevies a `SIGKILL`, + which results in a force-kill. !!! danger + All unsaved work is lost and cannot be restored after closing a session. !!! info + If you close Capella in the session manually, it will automatically restart. Please terminate sessions via the application context (like described above). - - diff --git a/docs/docs/user/sessions/types/index.md b/docs/docs/user/sessions/types/index.md index e31079d97..13c864cf4 100644 --- a/docs/docs/user/sessions/types/index.md +++ b/docs/docs/user/sessions/types/index.md @@ -15,14 +15,14 @@ will request 20GB of storage for your personal workspace. If your project uses the T4C-workflow, we will suggest all visible models in the T4C connection dialog. - ???+ tip + Starting the first time, your personal workspace will be empty. Please close the `Welcome`-dialog first: ![Close Welcome dialog](screenshots/close_welcome_dialog.png) - !!! info + Only work stored in the `/workspace` folder (default workspace folder) will be persistent. @@ -32,8 +32,8 @@ Jupyter notebooks allow you to programmatically explore (capella) models. You'll use the same shared workspace as with persistent Capella/Papyrus sessions. The same restrictions as with Capella sessions apply here. - !!! info + Jupyter notebooks use the same `/workspace` folder as is used with Capella sessions. @@ -42,14 +42,11 @@ sessions. The same restrictions as with Capella sessions apply here. Readonly Sessions allow you to read information from models without consuming a license. - !!! warning + Read-only sessions work only with linked git models. Please ask your project lead if your model has read-only support. - !!! danger - Any changes made in read-only sessions will NOT be saved and cannot be restored. - -*[T4C]: TeamForCapella + Any changes made in read-only sessions will NOT be saved and cannot be restored. diff --git a/docs/docs/user/sessions/types/persistent.md b/docs/docs/user/sessions/types/persistent.md index 79fc192c5..d69d23c0d 100644 --- a/docs/docs/user/sessions/types/persistent.md +++ b/docs/docs/user/sessions/types/persistent.md @@ -5,31 +5,28 @@ # Getting Started with a Persistent Session - - -1. To get started with a persistent session, you have to navigate to - `Sessions`. -2. Please select the tool and the version you'd like to work with: +1. To get started with a persistent session, you have to navigate to + `Sessions`. +2. Please select the tool and the version you'd like to work with: ![Request a persistent workspace](screenshots/request-session.png) -3. You should see your session listed under `Active sessions` on the right. +3. You should see your session listed under `Active sessions` on the right. ![Active sessions](screenshots/active-sessions.png) - Session spin-up may take up to 30 seconds before the connection button will - get enabled. First time start may take up to 1 minute. + Session spin-up may take up to 30 seconds before the connection button will + get enabled. First time start may take up to 1 minute. -4. Click the `Connect` button when it's enabled. A new popup opens, where you - can select `Connect to Session`. A new browser tab should open and you see - Capella loading. - ![Connect to session](screenshots/connect-to-session.png) +4. Click the `Connect` button when it's enabled. A new popup opens, where you + can select `Connect to Session`. A new browser tab should open and you see + Capella loading. ![Connect to session](screenshots/connect-to-session.png) !!! info - You can find your TeamForCapella session password in the connection - dialog. Please follow the [`TeamForCapella` guide](../..//tools/capella/teamforcapella/connect/index.md) - for more information. -5. When Capella is loaded you can start working. + You can find your TeamForCapella session password in the connection + dialog. Please follow the [`TeamForCapella` guide](../..//tools/capella/teamforcapella/connect/index.md) + for more information. + +5. When Capella is loaded you can start working. !!! info "Do you need access to a TeamForCapella model?" - Please continue with the [Connect to a `TeamForCapella` repository guide](../../tools/capella/teamforcapella/connect/index.md). - + Please continue with the [Connect to a `TeamForCapella` repository guide](../../tools/capella/teamforcapella/connect/index.md). diff --git a/docs/docs/user/tools/capella/git/index.md b/docs/docs/user/tools/capella/git/index.md index 922c34dfa..6d44129a8 100644 --- a/docs/docs/user/tools/capella/git/index.md +++ b/docs/docs/user/tools/capella/git/index.md @@ -28,8 +28,8 @@ clicking "Next" the "Branch Selection" opens. Here you can pick a branch on which you want to work. After clicking "Next" another time, the view "Local Destination" opens. This shows where your work is going to be stored locally. - !!! info + Tick the box: "Import all existing Eclipse projects after clone finishes" importing the cloned repository into your eclipse workspace @@ -91,8 +91,8 @@ Change #2 Thus you and your collegues know what happened in the commit. Then commit the changes (2). - !!! info + The commit is now made locally. In order to publish it and share it with other you have to push it to the *Remote*! ![Step 7: Search for View](screenshots/staged-changes.png) @@ -112,8 +112,8 @@ your collegues can see them. ## Diff and Merge Models - !!! warning + If you have to merge due to a merge conflict do not commit unless all conflicts highlighted are solved. If the merge tool is not opening on its own due to a merge conflict you can @@ -133,8 +133,8 @@ choose the **correct** order of which model is the source and which one is the target. In that case we are taking the changes in the source to apply them to the target, and are going to change the target model. - !!! warning + Make sure to select the correct direction of merging in order to modify the correct model. @@ -183,8 +183,8 @@ models is. Then you can right click on the change in the synthesis view and click "Apply change(s)" (2) and you can click "Ok" then. Afterwards make sure to Ctrl+S or File > Save to save the change made. - !!! warning + If any of your changes depend on common objects independent of layers make sure to also apply those changes in order to create a working modification of the model. @@ -267,13 +267,12 @@ project on Gitlab or Github. Then open a Merge request (Gitlab) or Pull request You will now see whether the Merge request/ Pull request can be merged automatically or not: - -1. It can be merged automatically: Go for it and merge it. To continue working - on the model, we recommend using a new clean session of Capella. -1. It can’t be merged automatically: You have now two options: - 1. Redo your work. We recommend using a new session for that. - 1. Open a service request or contact the operations team in order to try to - get your changes merged manually. +1. It can be merged automatically: Go for it and merge it. To continue working + on the model, we recommend using a new clean session of Capella. +1. It can’t be merged automatically: You have now two options: + 1. Redo your work. We recommend using a new session for that. + 1. Open a service request or contact the operations team in order to try + to get your changes merged manually. In order to publish your changes and to share them with your team click: "Commit and Push" (1). If you have not configured that before you are now asked diff --git a/docs/docs/user/tools/capella/migration/index.md b/docs/docs/user/tools/capella/migration/index.md index 593cf2d06..78704a866 100644 --- a/docs/docs/user/tools/capella/migration/index.md +++ b/docs/docs/user/tools/capella/migration/index.md @@ -5,27 +5,26 @@ # Update a Capella Model to a Newer Version - !!! warning + Create backups (e.g. in a Git repository) before you start the update process. A downgrade of Capella models is not possible. - !!! info + If you want to update a Capella model saved in TeamForCapella, please follow the TeamForCapella specific instructions instead: [Update a TeamForCapella based Capella model](../../../../admin/teamforcapella/migration.md). An administrator is required to update the Capella version in TeamForCapella. -1. Open a new persistent session with the old Capella version. -1. Import the model into your workspace. -1. Terminate the session. -1. Update the model version to the newer Capella version: - [Change model metadata](../../../projects/models/metadata.md). -1. Create a new session with the new Capella version. -1. In your persistent workspace loaded, execute the following steps: - - 1. Right click on the model in your workspace. - 1. Select `Migration` and `Migrate Project toward current version` - ![Migrate Capella model](./migrate-capella-model.png) - 1. A backup is recommended. - ![Enable backup option](./backup-migration.png) +1. Open a new persistent session with the old Capella version. +1. Import the model into your workspace. +1. Terminate the session. +1. Update the model version to the newer Capella version: + [Change model metadata](../../../projects/models/metadata.md). +1. Create a new session with the new Capella version. +1. In your persistent workspace loaded, execute the following steps: + 1. Right click on the model in your workspace. + 1. Select `Migration` and `Migrate Project toward current version` + ![Migrate Capella model](./migrate-capella-model.png) + 1. A backup is recommended. + ![Enable backup option](./backup-migration.png) diff --git a/docs/docs/user/tools/capella/t4c-git-compare.md b/docs/docs/user/tools/capella/t4c-git-compare.md index 5f8078f33..440563e1b 100644 --- a/docs/docs/user/tools/capella/t4c-git-compare.md +++ b/docs/docs/user/tools/capella/t4c-git-compare.md @@ -86,8 +86,7 @@ ## Some General Words - - + - **Git-only** - the modeling team uses a git repository to work on the model. The team may use git branches to work on features or capabilities in parallel and a main branch is used for integration and release-tagging. This way of @@ -111,5 +110,3 @@ For this co-working method to be enabled you need a valid TeamForCapella license and TeamForCapella server installed and integrated with Collab-Manager. - - diff --git a/docs/docs/user/tools/capella/teamforcapella/connect/index.md b/docs/docs/user/tools/capella/teamforcapella/connect/index.md index 2df32c7be..ab8d4dfc7 100644 --- a/docs/docs/user/tools/capella/teamforcapella/connect/index.md +++ b/docs/docs/user/tools/capella/teamforcapella/connect/index.md @@ -5,8 +5,8 @@ # Connect to a TeamForCapella Repository - -!!! Info +!!! info + Connecting to a T4C model in that way will open a connection and automatically write changes back to the T4C model. If you do not want to write changes back you can follow [the import T4C model](../import/index.md) @@ -15,54 +15,52 @@ To access a TeamForCapella based model you first need read/write access from a model lead (usually this role is allocated to lead architects / area owners). - -!!! Info +!!! info + Please [request a persistent session](../../../../sessions/request.md) before you continue with the instructions here. - - -1. During the session creation, you perhaps already noticed the TeamForCapella - session token. If you've already closed the dialog, please reopen it by - clicking `Connect` for your desired session under `Active Sessions`. - Whenever you create a session, we select all TeamForCapella models with the - same Capella version that you have access to. For those repositories, we - create a session token and register it with `TeamForCapella`. The access - is revoked after session termination. Please copy the session token (you - can just click on the text to copy it): +1. During the session creation, you perhaps already noticed the TeamForCapella + session token. If you've already closed the dialog, please reopen it by + clicking `Connect` for your desired session under `Active Sessions`. + Whenever you create a session, we select all TeamForCapella models with the + same Capella version that you have access to. For those repositories, we + create a session token and register it with `TeamForCapella`. The access is + revoked after session termination. Please copy the session token (you can + just click on the text to copy it): ![Session password](screenshots/session-token.png) -1. When Capella is finally loaded you navigate to `File` > `New` > `Other`. +1. When Capella is finally loaded you navigate to `File` > `New` > `Other`. ![Open Connection dialog](screenshots/step_1.png) -1. Expand `Team for Capella` and select `Capella Connected Project`: +1. Expand `Team for Capella` and select `Capella Connected Project`: ![Connect to remote model](screenshots/step_2.png) -1. In the drop down select the repository you like to work on. In most cases - the repository and project name should match. -1. Click on `Test connection` and enter you username and the session token you - received in the first step. +1. In the drop down select the repository you like to work on. In most cases + the repository and project name should match. +1. Click on `Test connection` and enter you username and the session token you + received in the first step. ![Test TeamForCapella connection](screenshots/cap-test-conn.jpg) !!! info - The username in the `Test connection` dialog should be already - pre-filled, however if this is not the case you may need to fill it in - manually. - !!! Bug - Do not make use of the `Remember me` functionality. + The username in the `Test connection` dialog should be already + pre-filled, however if this is not the case you may need to fill it in + manually. -1. When the connection test is completed successfully you can click the `Next` - button. -1. Finally a Project selection dialog should appear - the defaults are usually - good, just click `Finish`. This should result in a new folder - `project-name.team` in your Project Explorer. Open the project, locate a - file with a `.aird` extension and double-click it to open the model in - read-write mode. + !!! bug - ![Project explorer](screenshots/connection-example.jpg) + Do not make use of the `Remember me` functionality. + +1. When the connection test is completed successfully you can click the `Next` + button. +1. Finally a Project selection dialog should appear - the defaults are usually + good, just click `Finish`. This should result in a new folder + `project-name.team` in your Project Explorer. Open the project, locate a + file with a `.aird` extension and double-click it to open the model in + read-write mode. - + ![Project explorer](screenshots/connection-example.jpg) diff --git a/docs/docs/user/tools/capella/teamforcapella/export/index.md b/docs/docs/user/tools/capella/teamforcapella/export/index.md index 9264df7c7..40e72f5e2 100644 --- a/docs/docs/user/tools/capella/teamforcapella/export/index.md +++ b/docs/docs/user/tools/capella/teamforcapella/export/index.md @@ -5,8 +5,8 @@ # Export a Capella Model from your Persistent Workspace to a TeamForCapella Server - !!! warning + To export a Capella model to a TeamForCapella server, you need at least the `Read/Write`-permission for the project. diff --git a/docs/docs/user/tools/capella/teamforcapella/import/index.md b/docs/docs/user/tools/capella/teamforcapella/import/index.md index 4f62cd2fa..5a2952465 100644 --- a/docs/docs/user/tools/capella/teamforcapella/import/index.md +++ b/docs/docs/user/tools/capella/teamforcapella/import/index.md @@ -5,42 +5,45 @@ # Import a Capella Model from a TeamForCapella Server into your Persistent Workspace - !!! warning + To import a Capella model into your persistent workspace, you need at least the `Read/Write`-permission in the project. - !!! info + This imports a model into your workspace and changes are not automatically saved back to the T4C repository. If you want to save changes directly back to the server use [this](../connect/index.md) documentation. -1. Open a persistent session with the corresponding Capella version. -1. Wait until Capella has started. -1. Click on `File` > `Import...`.
- ![Capella import dialog](./capella-import-dialog.png) -1. A dialog with the title `Select` should open. In the dialog, expand - `TeamForCapella`, select `Capella project from remote repository` and - confirm with `Next`. - ![Import project from remote repository](./project-from-remote-repository.png) -1. Select the repository from the dropdown menu. Click on the `Test connection` - button and enter your [session token](../connect/index.md). - ![Select repository for import](./import-repository-selection.png) -1. Click on `Next` . - +1. Open a persistent session with the corresponding Capella version. +1. Wait until Capella has started. +1. Click on `File` > `Import...`.
+ ![Capella import dialog](./capella-import-dialog.png) +1. A dialog with the title `Select` should open. In the dialog, expand + `TeamForCapella`, select `Capella project from remote repository` and + confirm with `Next`. + ![Import project from remote repository](./project-from-remote-repository.png) +1. Select the repository from the dropdown menu. Click on the + `Test connection` button and enter your + [session token](../connect/index.md). + ![Select repository for import](./import-repository-selection.png) +1. Click on `Next` . + !!! warning - Do NOT modify the default location. Only the `/workspace` directory is persistent. - ![Use default location](./use-default-location.png) - + + Do NOT modify the default location. Only the `/workspace` directory is persistent. + ![Use default location](./use-default-location.png) + !!! hint - ![Project already exists in workspace](./project-already-exists-in-workspace.png) + + ![Project already exists in workspace](./project-already-exists-in-workspace.png){:style="width:400px"}
If you get the message `A project with the same name already exists in your workspace`, - change the name in the `Local Project Name` field. - ![Change local project name](./change-local-project-name.png) - -1. Select `Import all images` during the next step (step does not exist on - Capella 5.x.x). ![Import all images](./import-all-images.png) -1. Confirm with `Finish`. You should see a success message: - ![Imported resources](./imported-resources-message.png) -1. Click on `Ok` and the project should appear in your persistent workspace. + change the name in the `Local Project Name` field.

+ ![Change local project name](./change-local-project-name.png){:style="width:250px"} + +1. Select `Import all images` during the next step (step does not exist on + Capella 5.x.x). ![Import all images](./import-all-images.png) +1. Confirm with `Finish`. You should see a success message: + ![Imported resources](./imported-resources-message.png) +1. Click on `Ok` and the project should appear in your persistent workspace.