chore(docs): Streamline for integration into docs.opendesk.eu

2025-12-06 07:21:36 +01:00 · 2024-11-04 19:43:08 +00:00
parent c71faf5e80
commit f1202f5fa5
16 changed files with 27 additions and 16 deletions
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -4,7 +4,7 @@
 ---
 include:
  - project: "${PROJECT_PATH_GITLAB_CONFIG_TOOLING}"
-    ref: "v2.4.2"
+    ref: "v2.4.3"
    file:
      - "ci/common/automr.yml"
      - "ci/common/lint.yml"
@@ -514,7 +514,7 @@ avscan-prepare:
          CONTAINER_IMAGE: ""
          CONTAINER_REGISTRY: ""
          CONTAINER_TAG: ""
-          DATABASE_MIRROR: "https://registry.open-de.sk/repository/clamavdb.c3sl.ufpr.br"
+          DATABASE_MIRROR: "https://gitlab.opencode.de/bmi/opendesk/tooling/clamav-db-mirror/-/raw/main"
      EOF
    - >
      yq '.images
--- a/docs/ci.md
+++ b/docs/ci.md
@@ -2,6 +2,7 @@
 SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
 SPDX-License-Identifier: Apache-2.0
 -->
+
 <h1>CI/CD</h1>

 This page covers openDesk deployment automation via Gitlab CI.
--- a/docs/components.md
+++ b/docs/components.md
@@ -3,6 +3,7 @@ SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG Ze
 SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
 SPDX-License-Identifier: Apache-2.0
 -->
+
 <h1>Components</h1>

 This section covers the internal system requirements and external service requirements for productive use.
--- a/docs/debugging.md
+++ b/docs/debugging.md
@@ -2,8 +2,10 @@
 SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
 SPDX-License-Identifier: Apache-2.0
 -->
+
 <h1>Debugging</h1>

+<!-- TOC -->
 * [Disclaimer](#disclaimer)
 * [Enable debugging](#enable-debugging)
 * [Adding containers to a pod for debugging purposes](#adding-containers-to-a-pod-for-debugging-purposes)
@@ -15,6 +17,7 @@ SPDX-License-Identifier: Apache-2.0
  * [OpenProject](#openproject)
  * [PostgreSQL](#postgresql)
  * [Keycloak](#keycloak)
+<!-- TOC -->

 # Disclaimer

--- a/docs/development.md
+++ b/docs/development.md
@@ -7,8 +7,9 @@ SPDX-License-Identifier: Apache-2.0
 <h1>Developing openDesk deployment automation</h1>

 Active development on the deployment is currently only available for project members.
-However, contributions will be possible using the CLA process.
+However, contributions are possible using the [CLA](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/CONTRIBUTING.md?ref_type=heads) process.

+<!-- TOC -->
 * [Overview](#overview)
 * [Default branch, `develop` and other branches](#default-branch-develop-and-other-branches)
 * [External artifacts - `charts.yaml` and `images.yaml`](#external-artifacts---chartsyaml-and-imagesyaml)
@@ -18,6 +19,7 @@ However, contributions will be possible using the CLA process.
  * [Mirroring](#mirroring)
    * [Get new artifacts mirrored](#get-new-artifacts-mirrored)
 * [Creating new charts/images](#creating-new-chartsimages)
+<!-- TOC -->

 # Overview

--- a/docs/enhanced-configuration/groupware-migration.md
+++ b/docs/enhanced-configuration/groupware-migration.md
@@ -1,10 +1,11 @@
-r<!--
+<!--
 SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
 SPDX-License-Identifier: Apache-2.0
 -->

 <h1>Migration from M365 with audriga migration service and master authentication</h1>

+<!-- TOC -->
 * [Context](#context)
 * [Prerequisites](#prerequisites)
  * [Prepare M365 tenant for access](#prepare-m365-tenant-for-access)
@@ -17,8 +18,7 @@ SPDX-License-Identifier: Apache-2.0
    * [Add multiple user accounts via CSV file](#add-multiple-user-accounts-via-csv-file)
  * [Start the migration](#start-the-migration)
  * [Monitor migration status](#monitor-migration-status)
-
-# Context
+<!-- TOC -->

 Most organizations already have email accounts on various platforms that need to be migrated to openDesk. This document describes the migration from M365 accounts to openDesk using the [audriga Migration Service](https://www.audriga.com) in combination with the master authentication option in openDesk. Other source platforms are also supported, and their migrations work in a similar manner.

--- a/docs/enhanced-configuration/idp-federation.md
+++ b/docs/enhanced-configuration/idp-federation.md
@@ -5,6 +5,7 @@ SPDX-License-Identifier: Apache-2.0

 <h1>Federation with external identity provider (IdP)</h1>

+<!-- TOC -->
 * [Context](#context)
 * [Prerequisites](#prerequisites)
  * [User accounts](#user-accounts)
@@ -17,8 +18,7 @@ SPDX-License-Identifier: Apache-2.0
    * [Separate realm](#separate-realm)
    * [OIDC Client](#oidc-client)
  * [openDesk IdP](#opendesk-idp)
-
-# Context
+<!-- TOC -->

 Most organizations already have an Identity and Access Management (IAM) system with an identity provider (IdP) for single sign-on to internal or external web applications.

--- a/docs/enhanced-configuration/matrix-federation.md
+++ b/docs/enhanced-configuration/matrix-federation.md
@@ -12,8 +12,6 @@ SPDX-License-Identifier: Apache-2.0
  * [Separate Matrix domain](#separate-matrix-domain)
 <!-- TOC -->

-# Context
-
 The Element chat application and its server component Synapse are based on the Matrix protocol,
 that supports federation with other Matrix servers to communicate with the users with accounts on these servers.

--- a/docs/enhanced-configuration/self-signed-certificates.md
+++ b/docs/enhanced-configuration/self-signed-certificates.md
@@ -12,8 +12,6 @@ SPDX-License-Identifier: Apache-2.0
  * [Option 2: Use cert-manager.io](#option-2-use-cert-managerio)
 <!-- TOC -->

-# Use case
-
 Deploying openDesk into an environment with custom public key infrastructure (PKI) that is usually not part of
 public certificate authority chains or deploying openDesk into a local cluster without ACME challenge.

--- a/docs/enhanced-configuration/separate-mail-matrix-domain.md
+++ b/docs/enhanced-configuration/separate-mail-matrix-domain.md
@@ -5,6 +5,7 @@ SPDX-License-Identifier: Apache-2.0

 <h1>Separate domains for mail and or Matrix </h1>

+<!-- TOC -->
 * [Context](#context)
 * [Example configuration](#example-configuration)
  * [Mail domain](#mail-domain)
@@ -13,8 +14,7 @@ SPDX-License-Identifier: Apache-2.0
    * [Webserver](#webserver)
      * [Content Security Policy](#content-security-policy)
      * [.well-known](#well-known)
-
-# Context
+<!-- TOC -->

 As communication over mail and chat can go beyond the borders of your openDesk installation, you may want to use different domains for the mail and/or Matrix.

--- a/docs/migrations.md
+++ b/docs/migrations.md
@@ -5,6 +5,7 @@ SPDX-License-Identifier: Apache-2.0

 <h1>Updates & Upgrades</h1>

+<!-- TOC -->
 * [Disclaimer](#disclaimer)
 * [openDesk supported upgrade path](#opendesk-supported-upgrade-path)
 * [Releases upgrade details](#releases-upgrade-details)
@@ -26,6 +27,7 @@ SPDX-License-Identifier: Apache-2.0
    * [`migrations` S3 bucket](#migrations-s3-bucket)
 * [Related components and artifacts](#related-components-and-artifacts)
  * [Development](#development)
+<!-- TOC -->

 # Disclaimer

--- a/docs/requirements.md
+++ b/docs/requirements.md
@@ -2,6 +2,7 @@
 SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
 SPDX-License-Identifier: Apache-2.0
 -->
+
 <h1>Requirements</h1>

 This section covers the internal system requirements and external service requirements for productive use.
--- a/docs/scaling.md
+++ b/docs/scaling.md
@@ -5,7 +5,7 @@ SPDX-License-Identifier: Apache-2.0

 <h1>Scaling</h1>

-This document should cover the ability to scale apps.
+This document covers the ability to scale applications.

 # Horizontal scalability

--- a/docs/security-context.md
+++ b/docs/security-context.md
@@ -2,8 +2,10 @@
 SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
 SPDX-License-Identifier: Apache-2.0
 -->
+
 <h1>Kubernetes Security Context</h1>

+<!-- TOC -->
 * [Container Security Context](#container-security-context)
  * [allowPrivilegeEscalation](#allowprivilegeescalation)
  * [capabilities](#capabilities)
@@ -14,6 +16,7 @@ SPDX-License-Identifier: Apache-2.0
  * [readOnlyRootFilesystem](#readonlyrootfilesystem)
  * [runAsNonRoot](#runasnonroot)
 * [Status quo](#status-quo)
+<!-- TOC -->

 # Container Security Context

--- a/docs/theming.md
+++ b/docs/theming.md
@@ -5,7 +5,7 @@ SPDX-License-Identifier: Apache-2.0

 <h1>Theming</h1>

-This document will cover the theming options for an openDesk deployment.
+This document covers the theming options for an openDesk deployment.

 <!-- TOC -->
 * [Settings](#settings)
--- a/docs/workflow.md
+++ b/docs/workflow.md
@@ -6,6 +6,7 @@ SPDX-License-Identifier: Apache-2.0

 <h1>Technical development and release workflow</h1>

+<!-- TOC -->
 * [Scope](#scope)
 * [Roles and responsibilities](#roles-and-responsibilities)
 * [Deployment automation](#deployment-automation)
@@ -29,6 +30,7 @@ SPDX-License-Identifier: Apache-2.0
      * [Commit messages / Conventional Commits](#commit-messages--conventional-commits)
      * [Verified commits](#verified-commits)
 * [Footnotes](#footnotes)
+<!-- TOC -->

 # Scope