From 42a7d2dc9d24a245a51212e6d42562bddc787dde Mon Sep 17 00:00:00 2001 From: sjat Date: Sat, 18 Jul 2026 16:02:23 +0200 Subject: [PATCH] docs(ideas): add Project ideas page with status and owner columns Front-door menu of things we could build at a jam session, grouped into lab foundations, TaPPaaS production, OM tools, and housekeeping. Each idea carries a "done when" criterion, a status, and a claimable owner. Linked from the home page and added as a top-level nav entry. Co-Authored-By: Claude Opus 4.8 (1M context) --- docs/index.md | 2 + docs/project-ideas.md | 92 +++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 3 files changed, 95 insertions(+) create mode 100644 docs/project-ideas.md diff --git a/docs/index.md b/docs/index.md index c37c06b..9d841cb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,6 +6,8 @@ jam-session community focused on self-hosted, open-source infrastructure. ## Sections +- [Project ideas](project-ideas.md) β€” the menu of things we could build, fix, or + figure out at a jam session. Unclaimed ideas are up for grabs. - [Hardware](hardware/index.md) β€” every machine in the lab, auto-indexed from per-host frontmatter blocks. Use this when planning where to deploy a new service. - [Services](services/index.md) β€” the things we run on (or around) that diff --git a/docs/project-ideas.md b/docs/project-ideas.md new file mode 100644 index 0000000..fffa012 --- /dev/null +++ b/docs/project-ideas.md @@ -0,0 +1,92 @@ +--- +title: Project ideas +--- + +# Project ideas + +Things we could build, fix, or figure out at a MakerFLOSS jam session. This is a +**menu, not a backlog** β€” nothing here is promised to anyone, and picking +something up is as simple as putting your name in the Owner column. + +!!! tip "Add your own idea" + Edit this page in Forgejo (pencil icon, top right) or send a pull request. + See [Contributing](#contributing) at the bottom. + +## Status legend + +| Status | Meaning | +|---|---| +| πŸ’‘ **Idea** | Proposed, nobody has started. Up for grabs. | +| πŸ”¨ **In progress** | Somebody is actively working on it. | +| βœ… **Done** | Finished β€” usually with a page on this site to show for it. | +| ⏸️ **Parked** | Deliberately on hold. Reason noted in the row. | + +An empty **Owner** means the idea is unclaimed. Claim one by adding your name. + +## Lab & cluster foundations + +Getting the lab clusters to a state where we can actually build on them. + +| # | Idea | Done when… | Status | Owner | +|---|---|---|---|---| +| 1 | **Ansible control node on lab cluster 1** | A working control node exists from which the lab cluster can be configured declaratively. | πŸ’‘ Idea | | +| 2 | **User management for lab cluster 1** | We have decided on and set up an approach to accounts and access on the lab cluster. | πŸ’‘ Idea | | +| 3 | **Remote power on/off of rack equipment** | Rack hardware can be power-cycled without being physically in the room. | πŸ’‘ Idea | | +| 4 | **UPS strategy** | We have a decision: do we need a UPS, can we cover it with gear we already own, and should the clusters run networked NUT so hosts shut down cleanly? | πŸ’‘ Idea | | +| 5 | **Lab monitoring / dashboard** | One place to see what is up and what is down across the [hardware](hardware/index.md) we have. | πŸ’‘ Idea | | + +## Running things on TaPPaaS (production) + +The production cluster. Careful, deliberate work β€” see the +[house rules](house-rules.md): mistakes belong in the labs, not here. + +| # | Idea | Done when… | Status | Owner | +|---|---|---|---|---| +| 6 | **Guide: deploy a Docker container on TaPPaaS** | A reproducible walk-through in `docs/guides/` that a new maker can follow end to end. | πŸ’‘ Idea | | +| 7 | **Migrate Klaus' display project to TaPPaaS** | Evaluated first β€” then migrated if it fits. | πŸ’‘ Idea | | +| 8 | **Host Bo's QR-box-content project on TaPPaaS** | The project runs on TaPPaaS, including the DNS its QR codes depend on. | πŸ’‘ Idea | | +| 9 | **Backup & restore story for MakerFLOSS services** | Forgejo and the docs site have a documented, *tested* restore path. | πŸ’‘ Idea | | + +## Tools for Orange Makerspace + +MakerFLOSS is not the Orange Makerspace IT setup β€” but we help out where we can. + +| # | Idea | Done when… | Status | Owner | +|---|---|---|---|---| +| 10 | **Event management system** | OM events are organised in a system we host. Prior-art sweep first: is there a FLOSS tool we can adopt rather than build? | πŸ’‘ Idea | | +| 11 | **Todo-gizmo for OM** | A shared task system with both an online part and a physical part in the makerspace (status board / display). | πŸ’‘ Idea | | + +## Documentation & housekeeping + +Unglamorous, high-value, and easy to pick up for an evening. + +| # | Idea | Done when… | Status | Owner | +|---|---|---|---|---| +| 12 | **Nicer hardware labels** | Every device carries a printed label matching the [naming scheme](guides/hardware-naming-scheme.md). | πŸ’‘ Idea | | +| 13 | **Complete hardware specs on every host page** | Every device in [Hardware](hardware/index.md) has full frontmatter, with network details (ports, VLANs, patch-panel positions) double-checked. | πŸ’‘ Idea | | +| 14 | **Follow up on a dedicated ISP line** | We have a decision and a quote. | πŸ’‘ Idea | | +| 15 | **"First 30 minutes" onboarding page** | A new maker can get a Forgejo account, clone the repo, and land their first change by following one page. | πŸ’‘ Idea | | + +## Contributing + +Anyone can add an idea, claim one, or move a status. + +1. **Get a Forgejo account** at [forgejo.makerfloss.eu](https://forgejo.makerfloss.eu) + and ask in the MakerFLOSS Matrix room for contributor access to the repo. +2. **Small change?** Use the pencil icon at the top of this page β€” it opens the + file straight in Forgejo's editor. +3. **Bigger change?** Clone and work on a branch: + + ```bash + git clone ssh://git@forgejo.makerfloss.eu:7577/sjat/MakerFLOSS.git + cd MakerFLOSS + git switch -c my-idea + # edit docs/project-ideas.md + git commit -am "docs(ideas): add " + git push -u origin my-idea + ``` + + Then open a pull request. Editing *this* page needs no extra build steps β€” + but if you touch anything under `docs/hardware/`, run `make docs-index` + first and commit the regenerated files (see + [Editing the hardware docs](guides/editing-hardware-docs.md)). diff --git a/mkdocs.yml b/mkdocs.yml index 42298bf..278f617 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,6 +57,7 @@ hooks: nav: - Home: index.md + - Project ideas: project-ideas.md - Hardware: - hardware/index.md - Editing the hardware docs: guides/editing-hardware-docs.md