Skip to content

docs: annotation stack lifecycle design doc#175

Open
henrycgbaker wants to merge 3 commits intomainfrom
docs/annotation-bootstrap-clean
Open

docs: annotation stack lifecycle design doc#175
henrycgbaker wants to merge 3 commits intomainfrom
docs/annotation-bootstrap-clean

Conversation

@henrycgbaker
Copy link
Copy Markdown
Collaborator

@henrycgbaker henrycgbaker commented Apr 30, 2026

Goal

Add design doc for annotation-specific infrastructure: Docker stack lifecycle, compose distribution, and operational concerns for a self-hosted Argilla annotation campaign. Separated from shared config/settings (PR #162).

Scope

  • annotation-stack-lifecycle.md - stack composition, compose distribution (locked/package-data model), first-run/upgrade/uninstall lifecycle, prod bootstrap options, cross-platform runtime, and infra error taxonomy for pragmata annotation
  • README.md - index entry

Implementation

Design-only PR. No code changes.

Key decisions documented:

  • Locked compose model (option Y): compose file ships as package data under src/pragmata/annotation/, resolved via importlib.resources. Users never edit it directly.
  • Single shipped compose artefact (not dev/prod pair); dev overrides layer via Makefile using docker compose -f ... -f ...
  • No shipped bootstrap script for v0.1 - two-line install documented in README
  • pragmata annotation up / down as the single end-user stack lifecycle entry point

References

Introduces two new design documents:
- annotation-bootstrap.md: Docker stack lifecycle, compose distribution,
  first-run/upgrade/uninstall UX, prod bootstrap, and infra error taxonomy
  for pragmata annotation
- containerisation-and-deployment.md: artefact strategy, per-tool deployment
  shape, persistence/backup, and TLS considerations

Also adds both to the design docs index.
Remove draft ADR-0012 references, tighten prose, clarify up sequence
steps, and drop resolved open-questions table.
Rename reflects the full scope of the doc - stack composition, compose
distribution, lifecycle, and prod bootstrap - not just first-run setup.
@henrycgbaker henrycgbaker changed the title docs: annotation bootstrap and containerisation design docs docs: annotation stack lifecycle design doc Apr 30, 2026
@henrycgbaker henrycgbaker requested a review from saschagobel May 4, 2026 10:06
@saschagobel saschagobel added documentation Improvements or additions to documentation annotation labels May 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

annotation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants