Merge pull request #1697 from DSD-DBS/markdown-list-fixes-2

refactor(docs): Use indentation of 4 instead of 2

docs/.prettierrc.yaml

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0
+
+singleQuote: true
+overrides:
+  - files: '*.md'
+    options:
+      tabWidth: 4
+      proseWrap: always
+      printWidth: 79

docs/docs/admin/ci-templates/gitlab/image-builder.md

@@ -12,7 +12,7 @@ Please add the following section to your `.gitlab-ci.yml`:
 
 ```yaml
 include:
-  - remote: https://raw.githubusercontent.com/DSD-DBS/capella-collab-manager/${CAPELLA_COLLABORATION_MANAGER_REVISION}/ci-templates/gitlab/image-builder.yml
+    - remote: https://raw.githubusercontent.com/DSD-DBS/capella-collab-manager/${CAPELLA_COLLABORATION_MANAGER_REVISION}/ci-templates/gitlab/image-builder.yml
 ```
 
 The build images are tagged with the revision they were build with (e.g., when
@@ -22,13 +22,13 @@ running for main the tag would be `:main`). All characters matching the regex
 You have to add the following environment variables on repository level. Make
 sure to enable the "Expand variable reference" flag.
 
-- `PRIVATE_GPG_PATH`: Path to the private GPG key used to decrypt the
-  `secret.docker.json` file (More about this file [below](#docker-sops-file))
-- Variables specifying how to name each image:
-  - `FRONTEND_IMAGE_NAME` (defaults to `capella/collab/frontend`)
-  - `BACKEND_IMAGE_NAME` (default to `capella/collab/backend`)
-  - `DOCS_IMAGE_NAME` (defaults to `capella/collab/docs`)
-  - `GUACAMOLE_IMAGE_NAME` (defaults to `capella/collab/guacamole`)
+-   `PRIVATE_GPG_PATH`: Path to the private GPG key used to decrypt the
+    `secret.docker.json` file (More about this file [below](#docker-sops-file))
+-   Variables specifying how to name each image:
+    -   `FRONTEND_IMAGE_NAME` (defaults to `capella/collab/frontend`)
+    -   `BACKEND_IMAGE_NAME` (default to `capella/collab/backend`)
+    -   `DOCS_IMAGE_NAME` (defaults to `capella/collab/docs`)
+    -   `GUACAMOLE_IMAGE_NAME` (defaults to `capella/collab/guacamole`)
 
 This is the (minimal) configuration. For more advanced configuration options,
 please refer to the
@@ -45,11 +45,11 @@ following structure:
 
 ```yaml
 creation_rules:
-  - path_regex: .*
-    encrypted_regex: ^(password|secret|adminPassword|uri|token)
-    key_groups:
-      - pgp:
-          - <GPG fingerprint>
+    - path_regex: .*
+      encrypted_regex: ^(password|secret|adminPassword|uri|token)
+      key_groups:
+          - pgp:
+                - <GPG fingerprint>
 ```
 
 Ensure that the GPG fingerprint of the Gitlab runner is present in the
@@ -67,9 +67,9 @@ Then, enter the following content:
 
 ```json
 {
-  "registry": "<registry>",
-  "username": "<username>",
-  "password": "<password>"
+    "registry": "<registry>",
+    "username": "<username>",
+    "password": "<password>"
 }
 ```
 

docs/docs/admin/ci-templates/gitlab/k8s-deploy.md

@@ -12,17 +12,17 @@ Please add the following section to your `.gitlab-ci.yml`:
 
 ```yaml
 include:
-  - remote: https://raw.githubusercontent.com/DSD-DBS/capella-collab-manager/${CAPELLA_COLLABORATION_MANAGER_REVISION}/ci-templates/gitlab/k8s-deploy.yml
+    - remote: https://raw.githubusercontent.com/DSD-DBS/capella-collab-manager/${CAPELLA_COLLABORATION_MANAGER_REVISION}/ci-templates/gitlab/k8s-deploy.yml
 ```
 
 You have to add the following environment variables on repository level. Make
 sure to enable the "Expand variable reference" flag.
 
-- `PRIVATE_GPG_PATH`: Path to the private GPG key used to decrypt the
-  `secret.k8s.json` files.
-- `GRAFANA_HELM_CHART`: (Optional) - This variable is used to set the URL for
-  the Grafana Helm chart. It is useful if your deployment environment has
-  limited access, so you can specify a URL that is accessible for you.
+-   `PRIVATE_GPG_PATH`: Path to the private GPG key used to decrypt the
+    `secret.k8s.json` files.
+-   `GRAFANA_HELM_CHART`: (Optional) - This variable is used to set the URL for
+    the Grafana Helm chart. It is useful if your deployment environment has
+    limited access, so you can specify a URL that is accessible for you.
 
 ## SOPS configuration
 
@@ -34,11 +34,11 @@ following structure:
 
 ```yaml
 creation_rules:
-  - path_regex: .*
-    encrypted_regex: ^(password|secret|adminPassword|uri|token)
-    key_groups:
-      - pgp:
-          - <GPG fingerprint>
+    - path_regex: .*
+      encrypted_regex: ^(password|secret|adminPassword|uri|token)
+      key_groups:
+          - pgp:
+                - <GPG fingerprint>
 ```
 
 Ensure that the GPG fingerprint of the Gitlab runner is present in the
@@ -56,11 +56,11 @@ The file has to contain the following content:
 
 ```json
 {
-  "server": "<k8s server>",
-  "namespace": "<namespace>",
-  "release": "<release>",
-  "username": "<username>",
-  "token": "<unencrypted token>"
+    "server": "<k8s server>",
+    "namespace": "<namespace>",
+    "release": "<release>",
+    "username": "<username>",
+    "token": "<unencrypted token>"
 }
 ```
 

docs/docs/admin/getting_started/index.md

@@ -47,6 +47,6 @@ Collaboration Manager.
 
 More advanced features include:
 
-- Read-only models from Git
-- Connect to a Team4Capella server (commercial product)
-- Manage users and user access
+-   Read-only models from Git
+-   Connect to a Team4Capella server (commercial product)
+-   Manage users and user access

docs/docs/admin/installation.md

@@ -109,21 +109,24 @@ of memory.
 The Collaboration Manager requires two different namespaces. For security and
 overview reasons, they are separated:
 
-<!-- prettier-ignore -->
-- Capella Collaboration Manager control namespace: In this namespace, we run
-  the core application. It has full control over the sessions namespace and  consists of the following services:
-    - Frontend
-    - Backend
-    - Documentation
-    - Guacamole
-    - Prometheus
-    - Grafana (Loki), can be disabled in the `values.yaml`
-
-- Sessions namespace. The namespace is controlled by the control namespace and you won't need to touch it. In the session namespace, the following services run:
-    - Storage for persistent workspaces
-    - Storage for Juypter file-shares
-    - Pipeline jobs for nightly TeamForCapella to Git synchronisation
-    - Session containers (Capella, Papyrus, Juypter, pure::variants)
+-   Capella Collaboration Manager control namespace: In this namespace, we run
+    the core application. It has full control over the sessions namespace and
+    consists of the following services:
+
+    -   Frontend
+    -   Backend
+    -   Documentation
+    -   Guacamole
+    -   Prometheus
+    -   Grafana (Loki), can be disabled in the `values.yaml`
+
+-   Sessions namespace. The namespace is controlled by the control namespace
+    and you won't need to touch it. In the session namespace, the following
+    services run:
+    -   Storage for persistent workspaces
+    -   Storage for Juypter file-shares
+    -   Pipeline jobs for nightly TeamForCapella to Git synchronisation
+    -   Session containers (Capella, Papyrus, Juypter, pure::variants)
 
 ---
 
@@ -261,8 +264,8 @@ If a value is false, check the backend logs for more information.
     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)
+    -   [`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:
 

docs/docs/admin/settings/model-sources/git.md

@@ -22,27 +22,27 @@ Gitlab, are not available.
    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
 
@@ -55,8 +55,8 @@ Models are matched with instances with a longest prefix match of the URL.
 
 Let's construct a short example. We have two Git instances:
 
-- Instance one with the URL `https://git.example.com/`
-- Instance two with the URL `https://git.example.com/test`
+-   Instance one with the URL `https://git.example.com/`
+-   Instance two with the URL `https://git.example.com/test`
 
 A model with the path `https://git.example.com/test/test2.git` is now
 associated with instance two. A model with the path

docs/docs/admin/settings/tools/index.md

@@ -16,8 +16,8 @@ can be used as a web-based tool.
 
 Tools can be found in various places on the platform:
 
-- Models in projects are always assigned to a specific tool.
-- Sessions are always started for a specific tool.
+-   Models in projects are always assigned to a specific tool.
+-   Sessions are always started for a specific tool.
 
 Each tool has different versions and natures, which can be configured
 individually. Since different versions can be enabled in parallel, it helps to

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

@@ -34,14 +34,14 @@ 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)