Hosting — Documentatie

De AutoMate-documentatie bestaat uit twee Writerside-instanties die via GitHub Actions worden gebouwd en op verschillende platformen worden gehost.

Instanties

Instantie	ID	Inhoud	Publiek
Business Docs	`bd`	Gebruikershandleiding (Getting Started, Features, Releases)	Ja — klanten
Technical Docs	`td`	Developer documentatie (Architectuur, Features, Operations)	Nee — team only

Hosting

Business Docs

Omgeving	Platform	URL
Productie	Azure Static Web Apps	`https://docs.automate365.cloud/`
Development	Kubernetes (K8s)	Cluster `10.3.65.201`, namespace `automate-dev`

Technical Docs

Omgeving	Platform	URL
Productie	GitHub Pages	Team-only (private)
Development	Kubernetes (K8s)	Cluster `10.3.65.201`, namespace `automate-dev`

Build & Deploy pipelines

Op push naar `develop`

Workflow	Wat het doet
`docs-business.yml`	Bouwt BD instantie → deployt naar Azure Static Web Apps
`docs-technical.yml`	Bouwt TD instantie → deployt naar GitHub Pages
`docs-business-k8s.yml`	Bouwt BD instantie → Docker image → deployt naar K8s
`docs-technical-k8s.yml`	Bouwt TD instantie → Docker image → deployt naar K8s

Op pull request

Workflow	Wat het doet
`docs-pr-check.yml`	Bouwt beide instanties + Writerside checker → valideert referenties, images, IDs

Technische details

Writerside build

Beide instanties worden gebouwd met de JetBrains Writerside Docker builder:

Setting	Waarde
Docker versie	`243.22562`
GitHub Action	`JetBrains/writerside-github-action@v4`
Checker	`JetBrains/writerside-checker-action@v1`

Artifacts

Artifact	Beschrijving
`webHelpBD2-all.zip`	Business docs site
`webHelpTD2-all.zip`	Technical docs site
`algolia-indexes-*.zip`	Zoekindexen
`report.json`	Build rapport met warnings/errors

Kubernetes deployment

De K8s-deployments gebruiken een custom Docker image:

Image	Registry
`automate-docs-business`	`ghcr.io/{owner}/automate-docs-business`
`automate-docs-technical`	`ghcr.io/{owner}/automate-docs-technical`

Dockerfile: k8s/dockerfiles/Dockerfile.docs

Lokaal bouwen

cd Docs/Writerside

# Business docs bouwen
./build-local.sh

# Technical docs bouwen
./build-local.sh td

# Bekijken
cd build/{instance}/site && python3 -m http.server 8000

Bronbestanden

Pad	Inhoud
`Docs/Writerside/writerside.cfg`	Hoofdconfiguratie (beide instanties)
`Docs/Writerside/bd.tree`	Business docs navigatie
`Docs/Writerside/td.tree`	Technical docs navigatie
`Docs/Writerside/cfg/buildprofiles.xml`	Branding, kleurschema, footer
`Docs/Writerside/topics/Business/`	Business topic bestanden
`Docs/Writerside/topics/Technical/`	Technical topic bestanden
`Docs/Writerside/images/`	Screenshots en diagrammen

Last modified: 10 April 2026