MakerFLOSS/Makefile
sjat 4dc975062a
All checks were successful
Build docs site / build (push) Successful in 49s
Build slides / build (push) Successful in 1m11s
docs(hardware): reconcile rack01 to as-mounted layout and document cabling
Rebuild rack01 from the physically remounted hardware:
- Correct stale positions/ports/outlets for pp01, pp02, sw01, pdu01-04
- Model shelves as 1U trays (towers stand above without consuming rack U's);
  add shf02 and empty half-depth shf03/shf04
- Add ups01/ups02; reseat nas01/02 and sw02-05; move srv04-07 onto shf02
- Add `wan` hardware kind; add WAN demarcation hosts wan01 (active) and
  wan02 (staging)
- Document full live network wiring: srv01-07 -> pp02 -> sw01 (LAN) and
  srv01 eth0 -> pp02 -> pp01 -> wan01 (WAN); keep non-active lines
  (wan2, working-table patches, sw01 mgmt) in notes only
- Regenerate hardware index + rack01 elevation/network/power artifacts

Also includes the in-progress generator updates (gen_rack.py, gen_overview.py,
Makefile, tests) that the regenerated artifacts depend on.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-30 21:31:48 +02:00

43 lines
1.5 KiB
Makefile

.PHONY: help docs-index docs-build docs-serve docs-check slides test
help:
@echo "Targets:"
@echo " docs-index Regenerate docs/{hardware,services}/index.md from per-item frontmatter"
@echo " docs-build Build the static MkDocs site into ./site (strict)"
@echo " docs-serve Run a live-reload local preview server"
@echo " docs-check Drift-check: regenerate indices, fail if they differ from the committed copies"
@echo " slides Run build-slides.sh (Marp slides)"
@echo " test Run the Python unit tests (pytest)"
docs-index:
python3 scripts/gen_overview.py --category hardware
python3 scripts/gen_overview.py --category services
python3 scripts/gen_rack.py
docs-build:
mkdocs build --strict
docs-serve:
mkdocs serve
docs-check:
python3 scripts/gen_overview.py --category hardware
python3 scripts/gen_overview.py --category services
python3 scripts/gen_rack.py
@git diff --exit-code docs/hardware/index.md docs/services/index.md docs/infrastructure/racks/ \
|| { \
echo; \
echo "✗ The generated docs are out of date with the source files."; \
echo " The diff above is what 'make docs-index' just regenerated."; \
echo " This is what CI checks on push. To fix it:"; \
echo " 1. run 'make docs-index'"; \
echo " 2. commit the changed files (including the generated ones)"; \
echo " Guide: https://docs.makerfloss.eu/guides/editing-hardware-docs/"; \
exit 1; \
}
slides:
./build-slides.sh
test:
pytest -q