mirror of
https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git
synced 2025-12-05 23:11:40 +01:00
chore(docs): Separate developer from operations docs
This commit is contained in:
committed by
Thorsten Roßner
parent
9320274162
commit
799ba97b3c
@@ -9,7 +9,7 @@ Please read the [project's entire CONTRIBUTING.md](https://gitlab.opencode.de/bm
|
|||||||
|
|
||||||
# How to contribute?
|
# 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.
|
messages and branching convention.
|
||||||
|
|
||||||
## Helm vs. Operators vs. Manifests
|
## Helm vs. Operators vs. Manifests
|
||||||
|
|||||||
@@ -104,7 +104,7 @@ in the files from the release's git-tag:
|
|||||||
- `./helmfile/environments/default/images.yaml.gotmpl`
|
- `./helmfile/environments/default/images.yaml.gotmpl`
|
||||||
- `./helmfile/environments/default/charts.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
|
# Data Storage
|
||||||
|
|
||||||
@@ -123,7 +123,7 @@ If you want to address other topics, please check the section
|
|||||||
|
|
||||||
# Development
|
# 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
|
# License
|
||||||
|
|
||||||
|
|||||||
@@ -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
|
The `main` branch is configured to be the default branch, as visitors to the project on openCode should see that
|
||||||
branch by default.
|
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.
|
for more details on naming conventions.
|
||||||
|
|
||||||
# External artifacts - `charts.yaml.gotmpl` and `images.yaml.gotmpl`
|
# External artifacts - `charts.yaml.gotmpl` and `images.yaml.gotmpl`
|
||||||
@@ -238,7 +238,7 @@ The Standard Quality Gate addresses quality assurance steps that should be execu
|
|||||||
1. Linting
|
1. Linting
|
||||||
- Blocking
|
- Blocking
|
||||||
- Licensing: [reuse](https://github.com/fsfe/reuse-tool)
|
- 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
|
- Non-Blocking
|
||||||
- Security: [Kyverno policy check](../.kyverno) addressing some IT-Grundschutz requirements
|
- Security: [Kyverno policy check](../.kyverno) addressing some IT-Grundschutz requirements
|
||||||
- Formal: Yaml
|
- Formal: Yaml
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# 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
|
# yamllint disable rule:line-length
|
||||||
---
|
---
|
||||||
charts:
|
charts:
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# 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:
|
images:
|
||||||
bitnamiOSShell:
|
bitnamiOSShell:
|
||||||
|
|||||||
Reference in New Issue
Block a user