Skip to content

Commit 9ac402d

Browse files
committed
docs: Complete migration to HTML with Diataxis framework and add SVG diagrams
- Migrate 8 markdown files to 21 HTML pages following Diataxis framework: * 5 Tutorials (learning-oriented): deployment-guide, shared-storage-quickstart, gpu-workers, dataset-mounting, general-mounting * 6 How-To Guides (task-oriented): scale-workers, upgrade-concourse, configure-gpu, setup-shared-storage, monitor-prometheus, troubleshoot * 6 Reference pages (information-oriented): configuration, deployment-modes, relations, architecture, test-matrix, rocm-verification * 4 Explanation pages (understanding-oriented): shared-storage, key-distribution, gpu-architecture, container-runtime - Add 6 professional SVG diagrams replacing ASCII art: * TSA authentication flow with reverse tunnel (key-distribution.html) * Peer relation vs TSA/Flight relation comparison (key-distribution.html) * GPU container creation flow with runc wrapper (gpu-architecture.html) * Automatic upgrade sequence timeline (upgrade-concourse.html) * LXC UID/GID mapping with shift=true (shared-storage.html) - Fix all prometheus/grafana charm references: * Use prometheus-machine and grafana-machine in deploy commands * Maintain app names (prometheus, grafana) in relation endpoints * Updated in configuration.html and relations.html - Remove deprecated mode=all from all documentation - Add GitHub Pages workflow for documentation hosting - Delete 8 original markdown files after successful migration: deployment-guide.md, quickstart-shared-storage.md, gpu-support.md, dataset-mounting.md, general-mounting.md, shared-storage.md, ROCM_VERIFICATION.md, test-matrix.md - Update AGENTS.md with documentation structure - Update deploy-test.sh and shared-storage plan Breaking changes: Documentation now requires browser to view (HTML instead of markdown)
1 parent 04a5d66 commit 9ac402d

34 files changed

+13129
-2286
lines changed

.github/workflows/pages.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Deploy GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- '.github/workflows/pages.yml'
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
jobs:
25+
deploy:
26+
name: Deploy to GitHub Pages
27+
runs-on: ubuntu-latest
28+
environment:
29+
name: github-pages
30+
url: ${{ steps.deployment.outputs.page_url }}
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v4
34+
35+
- name: Setup Pages
36+
uses: actions/configure-pages@v5
37+
38+
- name: Upload artifact
39+
uses: actions/upload-pages-artifact@v3
40+
with:
41+
path: ./docs
42+
43+
- name: Deploy to GitHub Pages
44+
id: deployment
45+
uses: actions/deploy-pages@v4

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,11 @@ The `deploy-test.sh` script handles the entire lifecycle: build, deploy, verify,
8181
### Manual Deploy & Test (Local LXD)
8282
```bash
8383
# 1. Bootstrap a test controller (if not exists)
84-
# Note: --config test-mode=true sets update-status-hook-interval to 10s (vs 5m) for faster feedback
85-
juju bootstrap localhost test-controller --config test-mode=true
84+
juju bootstrap localhost test-controller
8685

8786
# 2. Deploy PostgreSQL (REQUIRED: 16/stable)
88-
juju add-model concourse-test
87+
# Note: --config test-mode=true sets update-status-hook-interval to 10s (vs 5m) for faster feedback
88+
juju add-model concourse-test --config test-mode=true
8989
juju deploy postgresql --channel 16/stable
9090

9191
# 3. Deploy Concourse (Auto-Scaling Mode)

docs/ROCM_VERIFICATION.md

Lines changed: 0 additions & 170 deletions
This file was deleted.

0 commit comments

Comments
 (0)