f9d6b57f0f
The docs lived on one lineage and the fleet code on another. That is why six pages described a shared fleet key as how an agent authenticates, why COLLECTOR-AUTH had to warn that the per-PC credential code was not in the repository it sat in, and why ADR-019 recorded a decision whose implementation was somewhere else. Documentation that cannot see the code it documents goes stale by construction, and no amount of editing fixes that. So the corpus moves here: 84 files, 56 pages, 20 ADRs, the proposals, INDEX.md, llms.txt and both gates. Filenames are unchanged, because a wiki page name is derived from the filename and a rename breaks every link anybody saved. THE POINT OF THE MOVE IS THE CORRECTION IT ENABLES. Every caveat that said "not in this tree" was false the moment the files landed beside the code, so each was rewritten from what is actually here: - COLLECTOR-AUTH gained the real enroll request body, the two bounds on the unauthenticated route (per-IP rate limit, pending cap with stale rows dropped before a real PC is refused), and the rejected pending reason that binds to the endpoint identity rather than the nonce. - ADR-019 now describes an implementation that is present, including its tests, and says plainly that what remains is the FLEET migration, not the code. - proposals/device-identity claimed phase 1 was unbuilt. plugins/computers declares deviceid on the collector schema and prefers it over the older fallbacks. Corrected in the page, its summary and the index. WINDOWS/IIS IS NOW DOCUMENTED AS THE LEGACY PATH, per the product decision, and carefully: it is what production runs today. Every Windows page opens by saying it is supported, not for a new site, and where a new site should go instead. No procedure was cut - an operator on an IIS box at 2am needs these pages to work exactly as well tomorrow. MIGRATE-TOPOLOGY stops being a footnote and becomes the off-ramp, which is why it nearly doubled: what was there did not match how the Docker stack really works here. The Docker material that already lived on this line was kept and given ownership rather than buried under the ported Windows-centric prose: DEPLOY now describes the four services, the migrate service that runs the upgrade chain before api starts, TLS terminated by nginx, and the plugin count corrected from thirteen to seventeen - a number both lineages had wrong. ROADMAP is rewritten from evidence rather than memory: what has shipped, read out of the changelog, the ADRs and the manifests, and ahead of it exactly two items - finalize a distributed release and polish the setup wizard. PROJECT-MAP is generated and was stale; the GENERATOR was what was wrong. --check passes now. API-REFERENCE is retired to a pointer. /api/docs serves 573 operations with derived auth, query parameters and harvested examples, and a hand-written page competing with that is a liability. The file stays so its wiki page and its inbound links survive. AND THE MOVE TURNED ON A SCRUB THAT HAD NEVER RUN HERE. test_docs_publishable keys on docs/*.md, which this line did not have, so it skipped - its own comment predicted what would surface. Porting the corpus activated it and it found 48 lines that must not reach a published wiki: branch names abbreviating the site, assistant-tooling paths, the site name in two deployment pages, and an employee ID in a Windows path that the scrub does not even look for.
76 lines
3.8 KiB
Markdown
76 lines
3.8 KiB
Markdown
<!-- docmeta
|
|
purpose: explanation
|
|
audience: developer
|
|
status: current
|
|
summary: Why the equipment domain was renamed to machines and machinetypes became modeltypes.
|
|
loadwith: none
|
|
-->
|
|
|
|
# ADR-011: Rename the equipment domain to machines; retype the models catalog with modeltypes
|
|
|
|
- **Status:** ACCEPTED
|
|
- **Date:** 2026-07-11
|
|
- **Deciders:** ShopDB maintainers
|
|
- **Relates to:** ADR-005 (equipment vs measuringtools scope), ADR-008 (plugin migration ownership)
|
|
|
|
## Context
|
|
|
|
ADR-005 split the old "equipment" concept: gage-lab instruments moved to the
|
|
measuringtools plugin, leaving the equipment plugin holding exactly one thing -
|
|
shop-floor machines (lathes, mills, CMMs, grinders, furnaces). The UI, the
|
|
routes (`/machines`), the frontend view folder (`views/machines/`), and even
|
|
the data vocabulary (asset numbers headed "MACHINE #") already said machines.
|
|
Only the code identity still said equipment: the plugin name, the API prefix,
|
|
the `equipment`/`equipmenttypes` tables, and the `assettype='equipment'` data
|
|
value. Every future contributor would pay a small permanent translation tax.
|
|
|
|
A display-label-only swap was shipped first (2026-07-11) and immediately showed
|
|
the dissonance: UI Machines over code equipment forever.
|
|
|
|
Separately, the legacy `machinetypes` table survived the Machine-model
|
|
retirement for one real reason: it types the vendor **models catalog**
|
|
(`models.machinetypeid`, 95 of 127 models) with fine-grained, cross-category
|
|
types (Lathe, Switch, Laser Printer). Its name was a misnomer - it never typed
|
|
machines specifically - and it squatted on the name the machines plugin's
|
|
subtype table wants.
|
|
|
|
The economics favor doing this now and never again: the plugin contract is
|
|
pre-1.0 (breaking changes are cheap per ADR-002), no sister site has adopted
|
|
yet, there is no production instance, and the test suite plus CI give the
|
|
strongest safety net the project has had.
|
|
|
|
## Decision
|
|
|
|
Rename the domain in one coordinated pass:
|
|
|
|
| Current | New | Rationale |
|
|
|---|---|---|
|
|
| `plugins/equipment/`, `/api/equipment`, `equipment.*` perms | `plugins/machines/`, `/api/machines`, `machines.*` | plugin identity matches the domain |
|
|
| `equipment` table, `equipmentid` | `machines`, `machineid` | main entity |
|
|
| `equipmenttypes`, `equipmenttypeid`, `equipmenttype` | `machinetypes`, `machinetypeid`, `machinetype` | subtypes take the freed name |
|
|
| legacy `machinetypes`, `models.machinetypeid` | `modeltypes`, `models.modeltypeid` | role-accurate: it types the models catalog, losslessly (no collapse to the 4 asset types) |
|
|
| `assettypes.assettype = 'equipment'` (data) | `'machine'` | the string compare sites flip with it |
|
|
|
|
Migration placement follows ADR-008: the modeltypes rename and the data flips
|
|
land in the core chain (core tables, core data); the plugin table renames land
|
|
in the machines plugin's own chain, idempotently guarded so fresh installs
|
|
(whose core chain still creates the old names at `7c04`) rename on first
|
|
`flask plugin upgrade-all`. The `alembic_version_equipment` version table is
|
|
renamed to `alembic_version_machines` by the core migration so the plugin chain
|
|
resumes seamlessly on existing installs. The plugin registry auto-migrates an
|
|
`equipment` key to `machines` on load.
|
|
|
|
Historical migrations and accepted ADRs are not rewritten; old ids and ADR-005
|
|
wording remain as history.
|
|
|
|
## Consequences
|
|
|
|
- Upgrading instances run `flask db upgrade` then `flask plugin upgrade-all`,
|
|
same as every deploy; both migrations are idempotent.
|
|
- `/api/equipment` and `equipmentApi` cease to exist - a breaking change made
|
|
while there is nobody to break. After contract 1.0 this class of rename
|
|
would be a major-version event; this is the last cheap moment.
|
|
- The "Machine Types" settings card becomes "Model Types" and finally says
|
|
what it does; the machines plugin's subtype card owns the machine-types name.
|
|
- Contributors stop translating between UI vocabulary and code vocabulary.
|