Files
shopdb-flask/docs/adr
cproudlock 105345fb3d
Some checks failed
CI / backend (push) Failing after 7s
CI / naming (push) Successful in 2s
CI / frontend (push) Successful in 9s
CI / migrations-mysql (push) Failing after 7s
Release 0.9.0
Product version to 0.9.0, frontend in lock-step, Unreleased notes moved into a
dated section per ADR-007. The plugin contract stays at 0.16.0: it moved after
v0.8.1 and is already recorded in this release's notes, and nothing since
touched the contract surface.

A minor rather than a patch: collector behaviour changed in ways an integrator
must know about. A reported machine number no longer becomes the PC's asset
number, it builds a controls link instead; a second PC claiming a machine is
treated as a claim rather than a handover; and a backup revision chain is now
per source PC rather than per asset.
2026-08-11 12:41:35 -04:00
..
2026-08-11 12:41:35 -04:00
2026-08-11 12:41:35 -04:00

Architecture Decision Records

Each ADR captures a single architectural decision: the context, the decision itself, the consequences, and the alternatives considered. ADRs are immutable once accepted. Superseded ADRs stay in this folder with a pointer to the newer ADR.

Status definitions

  • PROPOSED: drafted, awaiting decision
  • ACCEPTED: decision is in effect
  • SUPERSEDED: replaced by a later ADR (link forward)
  • DEPRECATED: no longer in effect, no replacement

Index

ADR Title Status
001 Asset model is the platform contract ACCEPTED
002 Plugin contract versioning (semver) ACCEPTED
003 Plugin distribution model ACCEPTED
004 Deployment topology (per-site instances) ACCEPTED
005 Equipment vs measuringtools plugin scope ACCEPTED
006 Plugin collector contract pattern ACCEPTED
007 Product versioning and releases ACCEPTED
008 Plugin migration ownership (per-plugin chains) ACCEPTED
009 Frontend plugin route gating ACCEPTED
010 Frontend plugin hook contract ACCEPTED
011 Machines rename + modeltypes retyping ACCEPTED
012 GE-Enforce manifest ownership in shopdb ACCEPTED
013 Plugin catalog, curated shelf, and lean per-site builds PROPOSED
014 Schema-lean per-site builds (retire cross-plugin FKs, prune not-installed plugin tables) ACCEPTED
015 Where a site's own data is allowed to live (setting, site directory, or seed) ACCEPTED
016 Credential delivery to the fleet (ShopDB-resolved targeting, encrypted at rest) ACCEPTED

Authoring

When proposing a new decision, copy the most recent ADR as a template, increment the number, and update this index. Do not edit accepted ADRs in place; supersede them with a new one.