sjat/MakerFLOSS
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
MakerFLOSS/docs/hardware/index.md

17 lines
761 B
Markdown
Raw Normal View History

feat(docs): MkDocs Material site + auto-generated hardware overview Bootstraps an MkDocs Material documentation site (rendered to docs.makerfloss.eu by the Forgejo Actions runner). The first feature is an auto-generated hardware overview built from per-host YAML frontmatter blocks under docs/hardware/. - mkdocs.yml, requirements.txt: MkDocs Material 9.5 + pyyaml - Makefile: docs-index | docs-build | docs-serve | docs-check - scripts/gen_overview.py: stdlib + pyyaml generator, deterministic and offline. Reads scripts/overview_config.yml — category-driven so services/vms can plug in later without touching the script. - scripts/overview_config.yml: hardware schema and index layout - docs/hardware/{makerfloss,fisi,tembo}.md: 3 sample entries - docs/hardware/index.md: GENERATED, committed (CI fails on drift) - docs/index.md: site landing page - .forgejo/workflows/docs.yml: drift-check + mkdocs build --strict + rsync site/ to /srv/docs-makerfloss/html on push to main - .gitignore: site/, .venv, __pycache__ Schema: - hostname, kind, status (required; kind/status are enums) - model, location, cpu, cpu_cores, cpu_threads, ram_gb, storage_gb, storage_type (enum), storage_notes, nic_gbps (all optional) - Filename stem MUST equal hostname (enforced by generator) - Extra optional fields are accepted silently and live on the per-page Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-17 21:10:58 +02:00
# Hardware Overview
_Auto-generated from `docs/hardware/*.md` — do not edit by hand. Run `make docs-index` after changing a file._
## Laptops
| Hostname | Model | Location | CPU | RAM | Storage | NIC | Status |
|---|---|---|---|---|---|---|---|
| [tembo](tembo.md) | ThinkPad T480 | Orange Makerspace (kiosk) | Intel Core i5-8350U · 4c/8t | 16 GB | 512 GB NVME | 1 GbE | in-use |
## Servers
| Hostname | Model | Location | CPU | RAM | Storage | NIC | Status |
|---|---|---|---|---|---|---|---|
| [fisi](fisi.md) | HP MicroServer Gen10 Plus | home rack | Xeon E-2226G · 6c/12t | 64 GB | 8 TB HDD | 1 GbE | in-use |
| [makerfloss](makerfloss.md) | Hetzner CX22 | Hetzner HEL1 (cloud) | AMD EPYC (shared vCPU) · 2c | 4 GB | 40 GB NVME | 1 GbE | in-use |
Reference in a new issue Copy permalink