sjat/MakerFLOSS
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Første midlertidige repo til Orange Makerspaces MakerFLOSS initiativ.
134 commits 2 branches 0 tags 702 KiB
Find a file
sjat 9d7b4684c4
All checks were successful
Build docs site / build (push) Successful in 48s
Details
Build slides / build (push) Successful in 1m11s
Details
docs: publish hardware naming scheme and link it from the editing guide 
Move the naming-scheme spec from notes/dev/specs/ into docs/guides/ so it
publishes to docs.makerfloss.eu, add it under the Hardware nav, and link it
from the editing guide. Repoint the stale references in CLAUDE.md and the
migration plan to the new path.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-29 21:40:09 +02:00
.forgejo/workflows ci(rack): generate rack artifacts, run tests, add nav entry 2026-06-24 14:00:48 +02:00
docs docs: publish hardware naming scheme and link it from the editing guide 2026-06-29 21:40:09 +02:00
notes docs: publish hardware naming scheme and link it from the editing guide 2026-06-29 21:40:09 +02:00
sandbox docs: add proper README at repo root and per-tree READMEs 2026-05-18 17:13:50 +02:00
scripts fix(rack): centre 0U rail labels across the bar (dominant-baseline) 2026-06-24 19:07:10 +02:00
slides Add marp slide infra and messaging alternatives presentation 2026-05-06 10:23:00 +02:00
tests fix(rack): centre 0U rail labels across the bar (dominant-baseline) 2026-06-24 19:07:10 +02:00
.gitignore feat(docs): MkDocs Material site + auto-generated hardware overview 2026-05-17 21:10:58 +02:00
build-slides.sh docs: split published site (docs/) from internal notes (notes/) 2026-05-18 16:53:27 +02:00
CLAUDE.md docs: publish hardware naming scheme and link it from the editing guide 2026-06-29 21:40:09 +02:00
LICENSE Initial commit 2026-03-17 10:39:20 +01:00
Makefile feat(rack): populate rack01 and wire gen_rack into make targets 2026-06-24 13:56:09 +02:00
mkdocs.yml docs: publish hardware naming scheme and link it from the editing guide 2026-06-29 21:40:09 +02:00
README.md docs: record hardware naming scheme, refresh stale mf0x hints 2026-06-24 16:26:11 +02:00
requirements-dev.txt feat(rack): gen_rack placement parsing and validation 2026-06-24 13:42:21 +02:00
requirements.txt feat(docs): MkDocs Material site + auto-generated hardware overview 2026-05-17 21:10:58 +02:00

README.md

MakerFLOSS

Documentation and working notes for MakerFLOSS, an Orange Makerspace initiative — a bi-weekly FLOSS jam-session community focused on self-hosted, open-source infrastructure.

Repository layout

docs/             # built into the public site (docs.makerfloss.eu)
  hardware/       # auto-indexed per-host frontmatter (srv01..srv05, makerfloss.eu)
  services/       # auto-indexed per-service frontmatter (docs, forgejo, …)
  infrastructure/ # labdesign, VPS/DNS, etc.
  presentations/  # Marp decks (also published to slides.makerfloss.eu)
notes/            # repo-only working material — not part of the site
  meetings/       # meeting notes (Danish allowed)
  todo/           # task lists, working norms, wishlist, services
  dev/            # internal plans/ and specs/
  communications/ # community comms artefacts
sandbox/          # scratch / pipeline fixtures
scripts/          # build helpers (hardware index, mkdocs hook)

Building locally

Requires Python 3.10+ and, for slide builds, either marp on $PATH or Docker.

python3 -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt

Common targets:

make docs-serve   # live-reload preview at http://127.0.0.1:8000
make docs-build   # strict build into ./site
make docs-index   # regenerate docs/hardware/index.md from per-host frontmatter
make docs-check   # CI drift-check for the hardware index
make slides       # build Marp decks (docs/presentations/*.md) into ./slides

CI runs on the self-hosted Forgejo Actions runner (.forgejo/workflows/docs.yml) and rsyncs the built site to the VPS.

Conventions

  • Filenames: ASCII lowercase, kebab-case (like-this.md). Dated docs use YYYY-MM-DD-label.md. Hardware host pages are the exception — their filename stem must equal the hostname field, enforced by scripts/gen_overview.py.
  • Languages: English for code and docs; Danish allowed in meeting notes and community communications.
  • Git: Trunk-based, feature branches, simple commit messages, no secrets in commits.

See CLAUDE.md for the full working norms and AI-collaboration guidance.

License

MIT — see LICENSE.