Move the documentation to the line that ships, and correct it against the code
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.
This commit is contained in:
@@ -1,7 +1,29 @@
|
||||
# ShopDB Production Readiness Assessment
|
||||
<!-- docmeta
|
||||
purpose: explanation
|
||||
audience: developer, adopter
|
||||
status: historical
|
||||
summary: The 2026-09-07 assessment of why deployment was hard. Its gaps became the roadmap; its recommendation was reversed.
|
||||
loadwith: none
|
||||
-->
|
||||
# Production readiness assessment, 2026-09-07
|
||||
|
||||
**Last Updated:** 2026-09-07
|
||||
**Branch:** wj (post-wilm merge)
|
||||
> **This is a record, not guidance.** Read it for WHY the deployment story
|
||||
> needed work, not for what to do. Two things have moved since:
|
||||
>
|
||||
> - **Its recommendation was reversed.** It recommends Windows/IIS for the
|
||||
> reference site and Docker only for new ones. The decision since is the
|
||||
> other way round: Docker is the path for every site and Windows/IIS is the
|
||||
> legacy topology that will be deprecated.
|
||||
> - **Its "critical path" became the roadmap.** Pre-built images in a registry,
|
||||
> one-command setup, automatic plugin registration and a simpler backup mode
|
||||
> are now the distributed-release item on [ROADMAP](../ROADMAP.md). Several
|
||||
> of its gaps are already closed: the `migrate` service runs the schema, the
|
||||
> plugin bootstrap and the seeders with no manual step, and
|
||||
> `docker-compose.prebuilt.yml` removes npm from the image build.
|
||||
>
|
||||
> Current pages: [DEPLOY](../DEPLOY.md) to stand a site up,
|
||||
> [DOCKER-PREBUILT-APPROACH](DOCKER-PREBUILT-APPROACH.md) to build it behind a
|
||||
> proxy, [ROADMAP](../ROADMAP.md) for what is left.
|
||||
|
||||
## Executive Summary
|
||||
|
||||
@@ -196,15 +218,17 @@ The Docker deployment requires extensive manual setup, multiple services, and as
|
||||
|
||||
## Honest Recommendations
|
||||
|
||||
### For West Jefferson (Your Site)
|
||||
### For the reference site
|
||||
|
||||
**Recommended:** Option 1 (IIS + Windows Services)
|
||||
|
||||
**Why:**
|
||||
- You already have Windows infrastructure
|
||||
*Reversed since. See the note at the top of this page.*
|
||||
|
||||
**Why (as argued at the time):**
|
||||
- The site already had Windows infrastructure
|
||||
- Simpler to operate
|
||||
- Faster to deploy
|
||||
- Your team knows IIS
|
||||
- The team knew IIS
|
||||
|
||||
**Steps:**
|
||||
1. Build Windows installer
|
||||
@@ -262,6 +286,9 @@ https://your-server:5001
|
||||
- `PRODUCTION-READINESS.md` - This file (meta/assessment)
|
||||
- `scripts/backup/README.md` - Backup system (3 containers, restic)
|
||||
|
||||
*Closed since: the first two were folded into `DEVELOPMENT-SETUP` and `DEPLOY`,
|
||||
and `INDEX.md` is now the single entry point this section asks for.*
|
||||
|
||||
**Problem:** Which one do I follow?
|
||||
|
||||
**Solution:** Create decision tree:
|
||||
@@ -279,7 +306,7 @@ https://your-server:5001
|
||||
|
||||
## What We Did Today (Honest Assessment)
|
||||
|
||||
[OK] **Merged wilm->wj** - 98 commits, wilm features now in wj
|
||||
[OK] **Merged the upstream development branch down** - 98 commits
|
||||
[OK] **Fixed local dev** - `run_dev.py` works for Windows development
|
||||
[OK] **Documented Docker** - Comprehensive but too complex
|
||||
[OK] **Added backup docs** - System works but needs expertise
|
||||
@@ -296,7 +323,7 @@ https://your-server:5001
|
||||
- Gets people to working system fast
|
||||
|
||||
2. **Test Windows Installer**
|
||||
- Build installer for wj branch
|
||||
- Build the installer for the deployment branch
|
||||
- Deploy to test Windows Server
|
||||
- Document any issues
|
||||
|
||||
@@ -308,7 +335,7 @@ https://your-server:5001
|
||||
|
||||
4. **Set up CI/CD for image builds**
|
||||
- GitHub Actions or Jenkins
|
||||
- Build on every push to wj
|
||||
- Build on every push to the deployment branch
|
||||
- Push to internal registry
|
||||
|
||||
5. **Create `deploy.sh` script**
|
||||
|
||||
Reference in New Issue
Block a user