Commit 9ac402d
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
File tree
34 files changed
+13129
-2286
lines changed- .github/workflows
- docs
- explanation
- howto
- reference
- tutorials
- scripts
34 files changed
+13129
-2286
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
81 | 81 | | |
82 | 82 | | |
83 | 83 | | |
84 | | - | |
85 | | - | |
| 84 | + | |
86 | 85 | | |
87 | 86 | | |
88 | | - | |
| 87 | + | |
| 88 | + | |
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
| |||
This file was deleted.
0 commit comments