Merge pull request #1673 from DSD-DBS/prettier-ignore-docs

chore(docs): Remove `prettier-ignore` where unnecessary

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.
 
-<!-- prettier-ignore-start -->
-
-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: <br>
-            :material-checkbox-blank-circle:{ style="color: #004085 " } `primary` <br>
-            :material-checkbox-blank-circle:{ style="color: #383d41 " } `secondary` <br>
-            :material-checkbox-blank-circle:{ style="color: #155724 " } `success` <br>
-            :material-checkbox-blank-circle:{ style="color: #721c24 " } `danger` <br>
-            :material-checkbox-blank-circle:{ style="color: #fff3cd " } `warning` <br>
-            :material-checkbox-blank-circle:{ style="color: #d1ecf1 " } `info` <br>
+
+        The alert level specifies
+        the background color of the alert. You can choose one of the following
+        options: <br>
+
+        :material-checkbox-blank-circle:{ style="color: #004085 " } `primary` <br>
+        :material-checkbox-blank-circle:{ style="color: #383d41 " } `secondary` <br>
+        :material-checkbox-blank-circle:{ style="color: #155724 " } `success` <br>
+        :material-checkbox-blank-circle:{ style="color: #721c24 " } `danger` <br>
+        :material-checkbox-blank-circle:{ style="color: #fff3cd " } `warning` <br>
+        :material-checkbox-blank-circle:{ style="color: #d1ecf1 " } `info` <br>
 
     !!! 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
         <a href="example.com">Link description</a>
         ```
-3. The alert is now created and is displayed to all users:
-    ![Success alert](success_alert.png)
 
-<!-- prettier-ignore-end -->
+3.  The alert is now created and is displayed to all users:
+    ![Success alert](success_alert.png)

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)
 
-<!-- prettier-ignore -->
-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
 
-<!-- prettier-ignore -->
 !!! 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.
 
-<!-- prettier-ignore -->
 !!! 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.
 
-<!-- prettier-ignore -->
-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
-   `<registry>/t4c/client/remote:<capella-version>-latest`
+1.  In the Collaboration Manager UI, change the docker image of the tool to
+    `<registry>/t4c/client/remote:<capella-version>-latest`

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:
-   <!-- prettier-ignore -->
-    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`.
-
-<!-- prettier-ignore -->
+
+   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.
 

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:
-    <!-- prettier-ignore -->
+
     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

docs/docs/admin/settings/tools/pure_variants.md

@@ -5,8 +5,8 @@
 
 # `pure::variants` Integration
 
-<!-- prettier-ignore -->
 !!! info
+
     The `pure::variants` integration can be used to:
 
     - Use pure::variants in a browser
@@ -15,8 +15,8 @@
 
 ## Setup of `pure::variants` Integration
 
-<!-- prettier-ignore -->
 !!! 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`

docs/docs/admin/teamforcapella/migration.md

@@ -5,39 +5,39 @@
 
 # How to Update a Capella Model to a Higher Version (in TeamForCapella)
 
-<!-- prettier-ignore -->
 !!! 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:
-   <!-- prettier-ignore -->
+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)
     1. A backup is not required as the latest version should still be available
        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)

docs/docs/admin/teamforcapella/project-integration/index.md

@@ -11,25 +11,27 @@ sources button for the model. <br />
 
 ## 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`.
-   <!-- prettier-ignore -->
+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.
-   <!-- prettier-ignore -->
+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.

docs/docs/admin/teamforcapella/project-management/index.md

@@ -23,7 +23,6 @@ guide.
 
 ## Delete a TeamForCapella Project
 
-<!-- prettier-ignore -->
 1. Open a persistent Capella session and connect to it.
 1. Enable the TeamForCapella administration capability: <br /> `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.

docs/docs/admin/teamforcapella/repository-management/index.md

@@ -25,8 +25,8 @@ all existing repositories with their status.
 
 ## Remove a TeamForCapella Repository
 
-<!-- prettier-ignore -->
 !!! danger
+
     Deleted TeamForCapella repositories can not be restored.
     If you don't have backups, the models in the repository are not recoverable!