Compare commits
2 Commits
hotfix/bac
...
feature/gi
| Author | SHA1 | Date | |
|---|---|---|---|
| 5679dac549 | |||
| 949c86eed0 |
@@ -6,9 +6,10 @@ on:
|
|||||||
paths:
|
paths:
|
||||||
- 'docs/**'
|
- 'docs/**'
|
||||||
- 'mkdocs.yml'
|
- 'mkdocs.yml'
|
||||||
|
- 'Dockerfile.docs'
|
||||||
|
- 'nginx.conf'
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-and-deploy:
|
build-and-deploy:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -16,10 +17,7 @@ jobs:
|
|||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: pip install mkdocs mkdocs-material
|
||||||
apt-get update -qq
|
|
||||||
apt-get install -y -qq python3-pip
|
|
||||||
pip3 install --break-system-packages mkdocs mkdocs-material
|
|
||||||
|
|
||||||
- run: mkdocs build
|
- run: mkdocs build
|
||||||
|
|
||||||
@@ -31,4 +29,4 @@ jobs:
|
|||||||
git config user.email "actions@forteapps.net"
|
git config user.email "actions@forteapps.net"
|
||||||
git add .
|
git add .
|
||||||
git commit -m "Deploy docs"
|
git commit -m "Deploy docs"
|
||||||
git push --force "https://x-token:${{ secrets.GITEA_TOKEN }}@git.forteapps.net/Forte/launchpad.git" HEAD:gitea-pages
|
git push --force "https://x-token:${{ gitea.token }}@git.forteapps.net/Forte/launchpad.git" HEAD:gitea-pages
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
standards_version: "2025.1"
|
standards_version: "2025.1"
|
||||||
last_configured: "2026-04-04"
|
last_configured: "2026-04-18"
|
||||||
components:
|
components:
|
||||||
github-pages: "2025.1"
|
gitea-pages: "2025.1"
|
||||||
github-pages-generator: "mkdocs"
|
gitea-pages-generator: "mkdocs"
|
||||||
github-pages-source: "docs/"
|
gitea-pages-source: "docs/"
|
||||||
github-pages-theme: "material"
|
gitea-pages-theme: "material"
|
||||||
|
|||||||
10
README.md
10
README.md
@@ -4,6 +4,7 @@
|
|||||||
|
|
||||||
[](https://argoproj.github.io/cd/)
|
[](https://argoproj.github.io/cd/)
|
||||||
[](https://upcloud.com/)
|
[](https://upcloud.com/)
|
||||||
|
[](https://git.forteapps.net/Forte/launchpad/pages/)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -11,6 +12,8 @@
|
|||||||
|
|
||||||
**New developers and operators**: Please refer to our comprehensive documentation for detailed guides and references:
|
**New developers and operators**: Please refer to our comprehensive documentation for detailed guides and references:
|
||||||
|
|
||||||
|
### 🌐 [**Live Documentation Site**](https://git.forteapps.net/Forte/launchpad/pages/) (Gitea Pages)
|
||||||
|
|
||||||
### 🎯 [**START HERE: Documentation Index**](docs/README.md)
|
### 🎯 [**START HERE: Documentation Index**](docs/README.md)
|
||||||
|
|
||||||
| Document | Description | Audience |
|
| Document | Description | Audience |
|
||||||
@@ -82,6 +85,10 @@ This repository contains the complete GitOps configuration for our Kubernetes cl
|
|||||||
.
|
.
|
||||||
├── bootstrap.sh # Cluster initialization script
|
├── bootstrap.sh # Cluster initialization script
|
||||||
├── _app-of-apps.yaml # Root ArgoCD Application (App-of-Apps pattern)
|
├── _app-of-apps.yaml # Root ArgoCD Application (App-of-Apps pattern)
|
||||||
|
├── mkdocs.yml # MkDocs configuration (Gitea Pages)
|
||||||
|
│
|
||||||
|
├── .gitea/workflows/ # Gitea Actions CI workflows
|
||||||
|
│ └── docs.yaml # Build & deploy MkDocs to Gitea Pages
|
||||||
│
|
│
|
||||||
├── infra/ # Infrastructure ArgoCD Applications (Kustomize multi-cluster)
|
├── infra/ # Infrastructure ArgoCD Applications (Kustomize multi-cluster)
|
||||||
│ ├── base/ # Base ArgoCD Application manifests (EU defaults)
|
│ ├── base/ # Base ArgoCD Application manifests (EU defaults)
|
||||||
@@ -344,6 +351,7 @@ kubectl patch application myapp -n argocd \
|
|||||||
| **OpenCost** | Cost monitoring | `monitoring` | 1 |
|
| **OpenCost** | Cost monitoring | `monitoring` | 1 |
|
||||||
| **Renovate** | Dependency updates | `renovate` | CronJob |
|
| **Renovate** | Dependency updates | `renovate` | CronJob |
|
||||||
| **Trivy** | Vulnerability scanning | `trivy-system` | 1 |
|
| **Trivy** | Vulnerability scanning | `trivy-system` | 1 |
|
||||||
|
| **Gitea Pages** | Documentation hosting | N/A (Gitea built-in) | N/A |
|
||||||
|
|
||||||
**Full specs**: [Technical Reference - Infrastructure Components](docs/REFERENCE.md#infrastructure-components)
|
**Full specs**: [Technical Reference - Infrastructure Components](docs/REFERENCE.md#infrastructure-components)
|
||||||
|
|
||||||
@@ -504,7 +512,7 @@ Internal use only. Not for public distribution.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Last Updated**: 2026-03-16
|
**Last Updated**: 2026-04-18
|
||||||
**Documentation Version**: 1.0.0
|
**Documentation Version**: 1.0.0
|
||||||
|
|
||||||
**🚀 Ready to get started? Check out the [Documentation Index](docs/README.md)!**
|
**🚀 Ready to get started? Check out the [Documentation Index](docs/README.md)!**
|
||||||
|
|||||||
@@ -11,6 +11,7 @@
|
|||||||
- [Enabling Authentication for Applications](#enabling-authentication-for-applications)
|
- [Enabling Authentication for Applications](#enabling-authentication-for-applications)
|
||||||
- [Adding a New Keycloak Client](#adding-a-new-keycloak-client)
|
- [Adding a New Keycloak Client](#adding-a-new-keycloak-client)
|
||||||
- [Troubleshooting](#troubleshooting)
|
- [Troubleshooting](#troubleshooting)
|
||||||
|
- [Documentation](#documentation)
|
||||||
- [Best Practices](#best-practices)
|
- [Best Practices](#best-practices)
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -1627,6 +1628,47 @@ If you're stuck:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
This repository's documentation is built with [MkDocs](https://www.mkdocs.org/) using the [Material](https://squidfund.github.io/mkdocs-material/) theme and published automatically to Gitea Pages.
|
||||||
|
|
||||||
|
### Viewing the Docs
|
||||||
|
|
||||||
|
The live documentation site is available at:
|
||||||
|
|
||||||
|
**https://git.forteapps.net/Forte/launchpad/pages/**
|
||||||
|
|
||||||
|
### Editing Documentation
|
||||||
|
|
||||||
|
All documentation source files live in the `docs/` directory as Markdown. To make changes:
|
||||||
|
|
||||||
|
1. Edit the relevant `.md` file in `docs/`
|
||||||
|
2. Commit and push to `main`
|
||||||
|
3. The Gitea Actions workflow automatically rebuilds and deploys the site
|
||||||
|
|
||||||
|
### Local Preview
|
||||||
|
|
||||||
|
To preview documentation changes locally before pushing:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install dependencies (one-time)
|
||||||
|
pip install mkdocs mkdocs-material
|
||||||
|
|
||||||
|
# Start the local dev server
|
||||||
|
mkdocs serve
|
||||||
|
```
|
||||||
|
|
||||||
|
Then open `http://127.0.0.1:8000` in your browser. The server live-reloads on file changes.
|
||||||
|
|
||||||
|
### How It Works
|
||||||
|
|
||||||
|
- **Workflow**: `.gitea/workflows/docs.yaml` triggers on pushes to `main` that change `docs/**`, `mkdocs.yml`, `Dockerfile.docs`, or `nginx.conf`
|
||||||
|
- **Build**: Installs MkDocs + Material theme, runs `mkdocs build`
|
||||||
|
- **Deploy**: Force-pushes the built `site/` directory to the `gitea-pages` branch
|
||||||
|
- **Serve**: Gitea Pages serves the static site from the `gitea-pages` branch
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Best Practices
|
## Best Practices
|
||||||
|
|
||||||
### Development Workflow
|
### Development Workflow
|
||||||
|
|||||||
@@ -1038,6 +1038,29 @@ resources:
|
|||||||
- `kubectl create job --from=cronjob/renovate renovate-test -n renovate` — manual trigger
|
- `kubectl create job --from=cronjob/renovate renovate-test -n renovate` — manual trigger
|
||||||
- `kubectl logs -n renovate job/renovate-test` — check logs
|
- `kubectl logs -n renovate job/renovate-test` — check logs
|
||||||
|
|
||||||
|
### Gitea Pages
|
||||||
|
|
||||||
|
**Purpose**: Hosts the MkDocs documentation site for this repository.
|
||||||
|
|
||||||
|
**How It Works**:
|
||||||
|
- A Gitea Actions workflow (`.gitea/workflows/docs.yaml`) builds MkDocs on push to `main`
|
||||||
|
- The built site is force-pushed to the `gitea-pages` branch
|
||||||
|
- Gitea serves the static site from that branch
|
||||||
|
|
||||||
|
**URL**: `https://git.forteapps.net/Forte/launchpad/pages/`
|
||||||
|
|
||||||
|
**Configuration**:
|
||||||
|
- Gitea server config: `ENABLE_GITEA_PAGES: true` (in gitea-values.yaml)
|
||||||
|
- MkDocs config: `mkdocs.yml` (repo root)
|
||||||
|
- Source files: `docs/` directory
|
||||||
|
- Theme: Material for MkDocs
|
||||||
|
|
||||||
|
**Trigger Paths**:
|
||||||
|
- `docs/**`
|
||||||
|
- `mkdocs.yml`
|
||||||
|
- `Dockerfile.docs`
|
||||||
|
- `nginx.conf`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Kyverno Policies
|
## Kyverno Policies
|
||||||
|
|||||||
Reference in New Issue
Block a user