From 799ba97b3ca18fd50d92c74652cdf67f423f3938 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Fischer?= Date: Wed, 30 Apr 2025 19:40:49 +0200 Subject: [PATCH] chore(docs): Separate developer from operations docs --- CONTRIBUTING.md | 2 +- README.md | 4 ++-- docs/{ => developer}/ci.md | 0 docs/{ => developer}/development.md | 2 +- docs/{ => developer}/workflow.md | 2 +- helmfile/environments/default/charts.yaml.gotmpl | 2 +- helmfile/environments/default/images.yaml.gotmpl | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) rename docs/{ => developer}/ci.md (100%) rename docs/{ => developer}/development.md (99%) rename docs/{ => developer}/workflow.md (99%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c788429c..130caf73 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ Please read the [project's entire CONTRIBUTING.md](https://gitlab.opencode.de/bm # How to contribute? -Please also read the [project's workflow documentation](./docs/workflow.md) for more details on standards like commit +Please also read the [project's workflow documentation](./docs/developer/workflow.md) for more details on standards like commit messages and branching convention. ## Helm vs. Operators vs. Manifests diff --git a/README.md b/README.md index 5d731696..78c2edb4 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ in the files from the release's git-tag: - `./helmfile/environments/default/images.yaml.gotmpl` - `./helmfile/environments/default/charts.yaml.gotmpl` -Find more information in our [Workflow documentation](./docs/workflow.md). +Find more information in our [Workflow documentation](./docs/developer/workflow.md). # Data Storage @@ -123,7 +123,7 @@ If you want to address other topics, please check the section # Development -If you want to join or contribute to the development of openDesk please read the [Development guide](./docs/development.md). +If you want to join or contribute to the development of openDesk please read the [Development guide](./docs/developer/development.md). # License diff --git a/docs/ci.md b/docs/developer/ci.md similarity index 100% rename from docs/ci.md rename to docs/developer/ci.md diff --git a/docs/development.md b/docs/developer/development.md similarity index 99% rename from docs/development.md rename to docs/developer/development.md index 95d3868c..72b70ede 100644 --- a/docs/development.md +++ b/docs/developer/development.md @@ -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 to the project on openCode should see that branch by default. -Please use the `develop` branch to diverge your branch(es) from. See the [workflow guide](./docs/workflow.md) +Please use the `develop` branch to diverge your branch(es) from. See the [workflow guide](./docs/developer/workflow.md) for more details on naming conventions. # External artifacts - `charts.yaml.gotmpl` and `images.yaml.gotmpl` diff --git a/docs/workflow.md b/docs/developer/workflow.md similarity index 99% rename from docs/workflow.md rename to docs/developer/workflow.md index 54b40a0d..a1e5537c 100644 --- a/docs/workflow.md +++ b/docs/developer/workflow.md @@ -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](./docs/development.md). + - openDesk specific: Especially `images.yaml.gotmpl` and `charts.yaml.gotmpl`, find more details in [development.md](./docs/developer/development.md). - Non-Blocking - Security: [Kyverno policy check](../.kyverno) addressing some IT-Grundschutz requirements - Formal: Yaml diff --git a/helmfile/environments/default/charts.yaml.gotmpl b/helmfile/environments/default/charts.yaml.gotmpl index 3999b855..3d898baa 100644 --- a/helmfile/environments/default/charts.yaml.gotmpl +++ b/helmfile/environments/default/charts.yaml.gotmpl @@ -2,7 +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 # -# Please read the /docs/development.md for information about structure and annotations used in this file. +# Please read the /docs/developer/development.md for information about structure and annotations used in this file. # yamllint disable rule:line-length --- charts: diff --git a/helmfile/environments/default/images.yaml.gotmpl b/helmfile/environments/default/images.yaml.gotmpl index 596450f9..10292024 100644 --- a/helmfile/environments/default/images.yaml.gotmpl +++ b/helmfile/environments/default/images.yaml.gotmpl @@ -2,7 +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 # -# Please read the /docs/development.md for information about structure and annotations used in this file. +# Please read the /docs/developer/development.md for information about structure and annotations used in this file. --- images: bitnamiOSShell: