Merge pull request 'docs: add issue cross-references to ROADMAP.md + update STATUS.md (closes #171, #170)' (#172) from feature/roadmap-status-crossrefs-171-170 into main
Build Docs Site / Aggregate OpenAPI Specs (push) Failing after 43s
Validate Flux manifests / kustomize-build (push) Failing after 30s

This commit was merged in pull request #172.
This commit is contained in:
2026-06-02 10:03:22 +00:00
2 changed files with 17 additions and 10 deletions
+7 -7
View File
@@ -6,9 +6,9 @@ Cross-repo milestones. Per-API phases live in each API repo's ROADMAP.md.
## Phase 0 — Orientation (one-time)
- [x] Audit cluster: nodes, namespaces, ingress, Flux state → `docs/cluster-audit.md` (issue #36 — closed ✅)
- [ ] Add Flux GitRepository + Kustomization watching `leeworks-agents/api-company`
- [ ] Deploy `gitea-act-runner` in cluster via Flux HelmRelease (`flux/gitea-runner/`)
- [ ] Stand up `registry.leeworks.dev` (container registry) — required before any API CI works
- [ ] Add Flux GitRepository + Kustomization watching `leeworks-agents/api-company` — issue #2
- [ ] Deploy `gitea-act-runner` in cluster via Flux HelmRelease (`flux/gitea-runner/`) — issue #3
- [ ] Stand up `registry.leeworks.dev` (container registry) — required before any API CI works — issue #4
## Phase 1 — API Contracts
Each API repo writes its `openapi.yaml` first and lints it. Spec is the source of truth.
@@ -23,16 +23,16 @@ Per-API: implement Fastify/FastAPI service matching `openapi.yaml` exactly. Rapi
- [x] VIN Decoder: Fastify server implementation (issue #121 — closed ✅)
## Phase 4 — Monitoring
- [ ] Prometheus + Grafana via Flux HelmRelease (`flux/monitoring/`)
- [ ] Gatus public status page at `status.leeworks.dev`
- [ ] Instrument every API with `api_requests_total`, `api_response_duration_seconds`, `api_data_freshness_seconds`
- [ ] Prometheus + Grafana via Flux HelmRelease (`flux/monitoring/`) — issue #7
- [ ] Gatus public status page at `status.leeworks.dev` — issue #8
- [ ] Instrument every API with `api_requests_total`, `api_response_duration_seconds`, `api_data_freshness_seconds` — issue #27
- [x] VIN Decoder metrics instrumentation + Grafana dashboard (issue #129 — closed ✅)
- [x] VIN Decoder Gatus health check (issue #134 — closed ✅)
## Phase 5 — Documentation site
- [x] `docs-site/` Astro + Redoc skeleton (issue #28 — closed ✅)
- [x] Gitea Actions pipeline that copies per-API `openapi.yaml` files at build time (issues #29 ✅, #38 ✅, #85 ✅)
- [ ] Deploy to `docs.leeworks.dev` via Flux
- [ ] Deploy to `docs.leeworks.dev` via Flux — issue #30
- [x] One SEO blog post per API minimum (issues #39 ✅ — ZIP/Holidays/AirQuality, #124 ✅ — VIN Decoder)
- [x] VIN Decoder docs page (issue #123 — closed ✅)
- [x] VIN Decoder SEO blog post (issue #124 — closed ✅)
+10 -3
View File
@@ -1,6 +1,6 @@
# Company Status
_Last updated: 2026-06-02 (triage cycle — #168 STATUS.md cleanup)_
_Last updated: 2026-06-02 (sprint planning cycle — #171/#170 ROADMAP/STATUS cross-refs)_
## APIs
| API | Spec | Code | Deployed | Listed on RapidAPI | Paying Users | MRR |
@@ -23,8 +23,15 @@ Legend: [x]=done, [~]=in-progress, [ ]=not started
- **Image automation:** `flux/image-automation/` — ImageRepository + ImagePolicy + ImageUpdateAutomation for all three APIs
- **VIN Decoder manifests:** `flux/vin-decoder/` — Flux HelmRelease + Kustomization committed (issue #140)
## Completed This Cycle (2026-06-02 — Triage Cycle #168)
- **#168** — STATUS.md cleanup: removed all stale "open, in progress" references to #120 and #121 (both confirmed closed ✅ in leeworks-agents/vin-decoder). Historical sections corrected. VIN Decoder Code column confirmed `[x]`.
## Completed This Cycle (2026-06-02 — Sprint Planning Cycle)
- **#171** — ROADMAP.md Phase 0 unchecked items annotated with issue #2, #3, #4; Phase 4 unchecked items annotated with issue #7, #8, #27; Phase 5 unchecked item annotated with issue #30. No checked-off items changed.
- **#170** — STATUS.md updated with 2026-06-02 sprint planning cycle results (this entry). Last updated date set to 2026-06-02.
- **Sprint Summary:** 2 new issues created (#171, #170), 0 issues closed this cycle, 0 stale found.
- **`kustomize build flux/` = PASS** — no regressions confirmed.
## Completed Previous Cycle (2026-06-02 — Triage Cycle #168)
- **#168** — STATUS.md cleanup: removed all stale “open, in progress” references to #120 and #121 (both confirmed closed ✅ in leeworks-agents/vin-decoder). Historical sections corrected. VIN Decoder Code column confirmed `[x]`.
- **`kustomize build flux/` = PASS** — no regressions.
## Completed Previous Cycle (2026-06-01 — Sprint Planning Cycle)