sheppy/opendesk
1
0
Fork 0
mirror of https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git synced 2025-12-06 07:21:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): Fix links in docs

Browse Source
This commit is contained in:
René Fischer
2025-04-11 08:54:33 +02:00
committed by Thorsten Roßner
parent a0f852e104
commit 08ee9ee44c
6 changed files with 18 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -96,7 +96,7 @@ Find out more about the permission system in the[roles & permissions concept](./
All technical releases are created using [Semantic Versioning](https://semver.org/lang/de/).
Gitlab provides an
[overview on the releases](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/releases)
[overview on the releases](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/releases)
of this project.
Please find a list of the artifacts related to the release either in the source code archive attached to the release or
@@ -115,8 +115,8 @@ More information about different data storages used within openDesk are describe
We love to get feedback from you!
Related to the deployment / contents of this repository,
please use the [issues within this project](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/issues).
For feedback related to the deployment / contents of this repository,
please use the [issues within this project](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/issues).
If you want to address other topics, please check the section
["Rückmeldungen und Beteiligung" in the OVERVIEW.md](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/OVERVIEW.md#rückmeldungen-und-beteiligung) of the [openDesk Info Repository](https://gitlab.opencode.de/bmi/opendesk/info).

4
docs/architecture.md
View File

@@ -237,7 +237,7 @@ The [OX SOAP API](https://oxpedia.org/wiki/index.php?title=Open-Xchange_Provisio
- (Managed) Resources
- Users
To find out more, see [Roles & Permissions](permissions.md).
To find out more, see [Roles & Permissions](./docs/permissions.md).
## SCIM
@@ -381,7 +381,7 @@ The end user focussed components are called applications and provide the functio
Other components are of type "Service", these are used for development and evaluation purposes only, they need to be replaced in production deployments.
For the APIs / Protocols supported by the applications, please read the [apis.md](./architecture/apis.md).
For the APIs / Protocols supported by the applications, please read the [apis.md](./docs/architecture/apis.md).
## Collabora (Office)

2
docs/development.md
View File

@@ -60,7 +60,7 @@ Before you investigate any app-specific configuration, it is recommended that yo
The `main` branch is configured to be the default branch, as visitors of the project on Open CoDE should see that
branch by default.
Please use the `develop` branch to diverge your branch(es) from. See the [workflow guide](./workflow.md)
Please use the `develop` branch to diverge your branch(es) from. See the [workflow guide](./docs/workflow.md)
for more details on naming conventions.
There is a CI bot that automatically creates a merge request once you initially push your branch to Open CoDE.

5
docs/getting-started.md
View File

@@ -230,6 +230,9 @@ ingress:
ingressClassName: "name-of-my-nginx-ingress"
```
Currently, the only supported ingress controller is `ingress-nginx` (see
[requirements.md](./docs/requirements.md)) for reference).
### Container runtime
Some apps require specific configurations for the container runtime. You can set your container runtime like `cri-o`,
@@ -263,7 +266,7 @@ cluster:
## Customize deployment
While openDesk configures the applications with meaningful defaults, you can check [functional.md](functional.md) if you want to change these defaults to better match your use case.
While openDesk configures the applications with meaningful defaults, you can check [functional.md](./docs/functional.md) if you want to change these defaults to better match your use case.
## Connectivity

2
docs/security.md
View File

@@ -29,7 +29,7 @@ All charts except the ones mentioned below are verifiable:
This list gives you an overview of default security settings and whether they comply with security standards:
⟶ Visit our generated detailed [Security Context](./security-context.md) overview.
⟶ Visit our generated detailed [Security Context](./docs/security-context.md) overview.
# NetworkPolicies

14
docs/workflow.md
View File

@@ -121,7 +121,7 @@ classDiagram
The focus of openDesk is to provide an integrated functional productivity platform based on the involved suppliers' functional components (products). These functional components usually rely on specific service components, e.g. database services for persistence. When running openDesk in production, the operator is responsible for providing these services in production-grade. For evaluation and development purposes, the openDesk deployment automation includes these services.
Find the list of functional and service components in the [deployment automation's components.md](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/blob/main/docs/components.md).
Find the list of functional and service components in the [archictecture documentation](./docs/architecture.md).
## Origins
@@ -146,7 +146,7 @@ openDesk uses Apache 2.0 as the license for their work. A typical reuse copyrigh
# SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
# SPDX-License-Identifier: Apache-2.0
```
The way to mark the license header as a comment differs between the various file types. Please find matching examples for all types across the [deployment automation repository](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/deployment/sovereign-workplace).
The way to mark the license header as a comment differs between the various file types. Please find matching examples for all types across the [deployment automation repository](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk).
> **Note**<br>
> If a `SPDX-FileCopyrightText` already exists with the copyright owner described above but with an past year (e.g. 2024), please update this copyright header line to cover (up to and including) the current year, e.g. `2024-2025`.
@@ -238,7 +238,7 @@ The Standard Quality Gate addresses quality assurance steps that should be execu
1. Linting
- Blocking
- Licensing: [reuse](https://github.com/fsfe/reuse-tool)
- openDesk specific: Especially `images.yaml.gotmpl` and `charts.yaml.gotmpl`, find more details in [development.md](./development.md).
- openDesk specific: Especially `images.yaml.gotmpl` and `charts.yaml.gotmpl`, find more details in [development.md](./docs/development.md).
- Non-Blocking
- Security: [Kyverno policy check](../.kyverno) addressing some IT-Grundschutz requirements
- Formal: Yaml
@@ -370,14 +370,14 @@ Commit messages must adhere to the [Conventional Commit standard](https://www.co
Example: `fix(open-xchange): Bump to 8.26 to heal issue with functional mailbox provisioning.`
> **Note**<br>
> The commit messages are an essential part of the [technical releases](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/releases) as the release's notes are generated from the messages.
> The commit messages are an essential part of the [technical releases](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/releases) as the release's notes are generated from the messages.
#### Verified commits
We only allow verified commits; please read on about the options you have to make your commits verified:
- https://docs.gitlab.com/ee/user/project/repository/ssh_signed_commits/
- https://docs.gitlab.com/ee/user/project/repository/gpg_signed_commits/
- https://docs.gitlab.com/ee/user/project/repository/x509_signed_commits/
- https://docs.gitlab.com/user/project/repository/signed_commits/ssh/
- https://docs.gitlab.com/user/project/repository/signed_commits/gpg/
- https://docs.gitlab.com/user/project/repository/signed_commits/x509/
# Footnotes