feat(docs): restructure root documentation and remove symlink

- Replace `README.md` symlink with a standalone file containing setup and usage instructions
- Refactor `docs/index.md` to serve as the primary documentation entry point with badges and navigation
- Organize content into logical sections: Usage, Charts, Deploy, Develop, Backup, Monitoring, and Migration
- Update chart references to use relative paths for local documentation links
This commit is contained in:
Janik von Rotz committed 2026-10-07 11:42:21 +02:00
1 parent 5785dfd11b
commit b616dd4b82
2 files changed
+96 -31

No files matched your search

-1
View File
@@ -1 +0,0 @@
docs/index.md
+54
View File
@@ -0,0 +1,54 @@
# Kubernetes Build
The Mint System collection of Helm charts.
---
Read the docs at [kubernetes.build](https://kubernetes.build).
## Setup
Clone this repo and enter the folder:
```bash
git clone git@github.com:Mint-System/Kubernetes-Build.git
cd Kubernetes-Build
```
Setup bash/zsh alias `task='./task'` with optional [completion](https://taskfile.build/#completion)
Show all available commands:
```bash
task help
```
## Documentation
Initialize the documentation build dependencies:
```bash
task init-zensical-docs
```
Run the documentation development server:
```bash
task dev-zensical-docs
```
Build the documentation website:
```bash
task build-zensical-docs
```
Serve the built documentation:
```bash
task serve-zensical-docs
```
## License
[AGPL-3.0-only](LICENSE)
+42 -30
View File
@@ -1,55 +1,67 @@
# Kubernetes Build
Kubernetes Build
===
[![.github/workflows/package.yml](https://github.com/Mint-System/Kubernetes-Build/actions/workflows/package.yml/badge.svg)](https://github.com/Mint-System/Kubernetes-Build/actions/workflows/package.yml) [![.github/workflows/test.yml](https://github.com/Mint-System/Kubernetes-Build/actions/workflows/test.yml/badge.svg)](https://github.com/Mint-System/Kubernetes-Build/actions/workflows/test.yml) [![matrix-badge](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#odoo-build:mint-system.ch)
The Mint System collection of Helm charts.
---
- **Install**: Install Helm repository and get started with Odoo.
- **Develop**: Deploy Odoo and Postgres to a local Kubernetes cluster.
- **Build**: Fork and build your own Helm charts.
- **Deploy**: Configure and deploy Helm charts to remote clusters.
- **Bootstrap**: Bootstrap new Kubernetes clusters.
Read the docs at [kubernetes.build](https://kubernetes.build).
## Usage
## Setup
You can use this project as any other Helm chart repository.
Clone this repo and enter the folder:
Add [this Helm repository](/index.yaml).
```bash
git clone git@github.com:Mint-System/Kubernetes-Build.git
cd Kubernetes-Build
helm repo add kubernetes-build https://kubernetes.build
```
Setup bash/zsh alias `task='./task'` with optional [completion](https://taskfile.build/#completion)
Show all available commands:
Install a chart.
```bash
task help
helm install "$NAME" "kubernetes-build/$NAME"
```
## Charts
## Documentation
List of charts:
Initialize the documentation build dependencies:
- [cluster-issuer](cluster-issuer/README.md)
- [deployment-updater](deployment-updater/README.md)
- [forgejo-runner](forgejo-runner/README.md)
- [nextcloud](nextcloud/README.md)
- [odoo](odoo/README.md)
- [postgres](postgres/README.md)
- [prometheus-agent](prometheus-agent/README.md)
- [taskfile-build](taskfile-build/README.md)
- [vshn-postgres](vshn-postgres/README.md)
```bash
task init-zensical-docs
```
## Deploy
Run the documentation development server:
You can use this project to deploy the charts to these Kubernetes clusters:
```bash
task dev-zensical-docs
```
- [APPUiO](./APPUiO.md)
- [Exoscale](./Exoscale.md)
- [Infomaniak](./Infomaniak.md)
- [K3s](./K3s.md)
Build the documentation website:
## Develop
```bash
task build-zensical-docs
```
The [Development](./Development.md) covers everything to start developing the Helm charts.
Serve the built documentation:
## Backup
```bash
task serve-zensical-docs
```
Have a look at the [Backup](./Backup.md) page to learn about how the services make backups.
## License
## Monitoring
[AGPL-3.0-only](LICENSE)
Checkout the [Monitor](./Monitor.md) page to learn about how services are monitored.
## Migration
To execute migrations have a look at [Migration](Migration.md).