Merge pull request 'docs: update ROADMAP.md checkboxes and STATUS.md sprint state (closes #156, closes #158)' (#159) from feature/156-158-roadmap-status-update into main
This commit was merged in pull request #159.
This commit is contained in:
+8
-8
@@ -5,7 +5,7 @@ Cross-repo milestones. Per-API phases live in each API repo's ROADMAP.md.
|
|||||||
> **As of 2026-05-30, a 4th API (VIN Decoder) has been added. Per-API phases also live in `leeworks-agents/vin-decoder`.**
|
> **As of 2026-05-30, a 4th API (VIN Decoder) has been added. Per-API phases also live in `leeworks-agents/vin-decoder`.**
|
||||||
|
|
||||||
## Phase 0 — Orientation (one-time)
|
## Phase 0 — Orientation (one-time)
|
||||||
- [ ] Audit cluster: nodes, namespaces, ingress, Flux state → `docs/cluster-audit.md`
|
- [x] Audit cluster: nodes, namespaces, ingress, Flux state → `docs/cluster-audit.md` (issue #36 — closed ✅)
|
||||||
- [ ] Add Flux GitRepository + Kustomization watching `leeworks-agents/api-company`
|
- [ ] Add Flux GitRepository + Kustomization watching `leeworks-agents/api-company`
|
||||||
- [ ] Deploy `gitea-act-runner` in cluster via Flux HelmRelease (`flux/gitea-runner/`)
|
- [ ] 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
|
- [ ] Stand up `registry.leeworks.dev` (container registry) — required before any API CI works
|
||||||
@@ -26,21 +26,21 @@ Per-API: implement Fastify/FastAPI service matching `openapi.yaml` exactly. Rapi
|
|||||||
- [ ] Prometheus + Grafana via Flux HelmRelease (`flux/monitoring/`)
|
- [ ] Prometheus + Grafana via Flux HelmRelease (`flux/monitoring/`)
|
||||||
- [ ] Gatus public status page at `status.leeworks.dev`
|
- [ ] Gatus public status page at `status.leeworks.dev`
|
||||||
- [ ] Instrument every API with `api_requests_total`, `api_response_duration_seconds`, `api_data_freshness_seconds`
|
- [ ] Instrument every API with `api_requests_total`, `api_response_duration_seconds`, `api_data_freshness_seconds`
|
||||||
- [ ] VIN Decoder metrics instrumentation + Grafana dashboard (issue #129)
|
- [x] VIN Decoder metrics instrumentation + Grafana dashboard (issue #129 — closed ✅)
|
||||||
- [x] VIN Decoder Gatus health check (issue #134 — closed ✅)
|
- [x] VIN Decoder Gatus health check (issue #134 — closed ✅)
|
||||||
|
|
||||||
## Phase 5 — Documentation site
|
## Phase 5 — Documentation site
|
||||||
- [ ] `docs-site/` Astro + Redoc skeleton
|
- [x] `docs-site/` Astro + Redoc skeleton (issue #28 — closed ✅)
|
||||||
- [ ] Gitea Actions pipeline that copies per-API `openapi.yaml` files at build time
|
- [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
|
||||||
- [ ] One SEO blog post per API minimum (see master prompt §Phase 5)
|
- [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 docs page (issue #123 — closed ✅)
|
||||||
- [x] VIN Decoder SEO blog post (issue #124 — closed ✅)
|
- [x] VIN Decoder SEO blog post (issue #124 — closed ✅)
|
||||||
|
|
||||||
## Phase 6 — Pre-launch
|
## Phase 6 — Pre-launch
|
||||||
- [ ] `docs/legal/terms-of-service.md`
|
- [x] `docs/legal/terms-of-service.md` (issue #40 — closed ✅)
|
||||||
- [ ] `docs/legal/privacy-policy.md`
|
- [x] `docs/legal/privacy-policy.md` (issue #40 — closed ✅)
|
||||||
- [ ] `docs/legal/acceptable-use-policy.md`
|
- [x] `docs/legal/acceptable-use-policy.md` (issues #40 ✅, #89 ✅)
|
||||||
- [ ] DNS: `zip.leeworks.dev`, `holidays.leeworks.dev`, `aqi.leeworks.dev`, `docs.`, `status.`, `registry.`
|
- [ ] DNS: `zip.leeworks.dev`, `holidays.leeworks.dev`, `aqi.leeworks.dev`, `docs.`, `status.`, `registry.`
|
||||||
- [x] VIN Decoder DNS `vin.leeworks.dev` (issue #130 — closed ✅)
|
- [x] VIN Decoder DNS `vin.leeworks.dev` (issue #130 — closed ✅)
|
||||||
- [x] VIN Decoder RapidAPI listing (issue #131 — closed ✅ as tracker; operator action required)
|
- [x] VIN Decoder RapidAPI listing (issue #131 — closed ✅ as tracker; operator action required)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Company Status
|
# Company Status
|
||||||
|
|
||||||
_Last updated: 2026-05-31 (sprint planning cycle)_
|
_Last updated: 2026-06-01 (sprint triage cycle)_
|
||||||
|
|
||||||
## APIs
|
## APIs
|
||||||
| API | Spec | Code | Deployed | Listed on RapidAPI | Paying Users | MRR |
|
| API | Spec | Code | Deployed | Listed on RapidAPI | Paying Users | MRR |
|
||||||
@@ -23,6 +23,30 @@ Legend: [x]=done, [~]=in-progress, [ ]=not started
|
|||||||
- **Image automation:** `flux/image-automation/` — ImageRepository + ImagePolicy + ImageUpdateAutomation for all three APIs
|
- **Image automation:** `flux/image-automation/` — ImageRepository + ImagePolicy + ImageUpdateAutomation for all three APIs
|
||||||
- **VIN Decoder manifests:** `flux/vin-decoder/` — Flux HelmRelease + Kustomization committed (issue #140)
|
- **VIN Decoder manifests:** `flux/vin-decoder/` — Flux HelmRelease + Kustomization committed (issue #140)
|
||||||
|
|
||||||
|
## Completed This Cycle (2026-06-01 — Sprint Triage)
|
||||||
|
- **#158** — STATUS.md updated with 2026-06-01 current blockers and sprint summary.
|
||||||
|
- **#156** — ROADMAP.md checkboxes updated: Phase 4 VIN Decoder metrics, Phase 5 docs-site/pipeline/blog, Phase 6 legal docs all checked off.
|
||||||
|
- **`kustomize build flux/` = PASS** — no regressions.
|
||||||
|
|
||||||
|
## Current Blockers (as of 2026-06-01)
|
||||||
|
|
||||||
|
In dependency order — operator tasks unless noted:
|
||||||
|
|
||||||
|
1. **P1 #47** — Create `0xWheatyz/api-company` upstream repo (operator) — **highest priority, unblocks everything**
|
||||||
|
2. **P1 #76** — Create `gitea-leeworks-agents-token` secret in `flux-system` (operator)
|
||||||
|
3. **P1 #77** — Create `gitea-runner-token` secret in `gitea-runner` namespace (operator)
|
||||||
|
4. **P1 #79** — Create `gitea-registry` imagePullSecrets in all API namespaces (operator)
|
||||||
|
5. **P1 #83** — Configure `GITEA_TOKEN` Actions secret in zip-enrichment, holidays, air-quality repos (operator)
|
||||||
|
6. **P1 #120** — VIN Decoder data layer — SQLite cache seeded from NHTSA vPIC (**agent — actionable now, not blocked**)
|
||||||
|
7. **P1 #121** — VIN Decoder Fastify server implementation (agent — depends on #120)
|
||||||
|
8. **P1 #126** — Configure `GITEA_TOKEN` Actions secret in vin-decoder repo (operator — depends on #122 ✅)
|
||||||
|
9. **P1 #127** — Create `gitea-registry` imagePullSecret in `vin-decoder` namespace (operator)
|
||||||
|
|
||||||
|
## Sprint Summary (2026-06-01)
|
||||||
|
- **Issues closed since last STATUS update (#146):** #145–#154 — VIN Decoder sprint docs + infra (✅ all closed)
|
||||||
|
- **Issues opened this sprint:** #150 (vin DNS reminder), #151 (VIN Decoder RapidAPI tiers), #155 (if applicable), #156 (ROADMAP.md update), #157 (full-stack validation), #158 (STATUS.md update)
|
||||||
|
- **Top actionable agent task:** VIN Decoder code work — #120 (data layer) then #121 (Fastify server)
|
||||||
|
|
||||||
## Completed This Cycle (2026-05-31 — Sprint Cycle)
|
## Completed This Cycle (2026-05-31 — Sprint Cycle)
|
||||||
- **#146** — STATUS.md updated to reflect VIN Decoder sprint wave (#117–#141): APIs table row added, completed wave documented, blockers updated.
|
- **#146** — STATUS.md updated to reflect VIN Decoder sprint wave (#117–#141): APIs table row added, completed wave documented, blockers updated.
|
||||||
- **#145** — ROADMAP.md updated to reference VIN Decoder as 4th API across all phases (Phase 1–6). `kustomize build flux/` = PASS.
|
- **#145** — ROADMAP.md updated to reference VIN Decoder as 4th API across all phases (Phase 1–6). `kustomize build flux/` = PASS.
|
||||||
@@ -48,6 +72,8 @@ Legend: [x]=done, [~]=in-progress, [ ]=not started
|
|||||||
- **#141** — Pricing page updated for VIN Decoder — **closed ✅** (PR #144 merged)
|
- **#141** — Pricing page updated for VIN Decoder — **closed ✅** (PR #144 merged)
|
||||||
|
|
||||||
## Critical Path (operator must complete in order)
|
## Critical Path (operator must complete in order)
|
||||||
|
See **Current Blockers** section above for the full ordered list as of 2026-06-01.
|
||||||
|
|
||||||
1. **Create `0xWheatyz/api-company` repo** (#47) — **highest priority, unblocks everything**
|
1. **Create `0xWheatyz/api-company` repo** (#47) — **highest priority, unblocks everything**
|
||||||
2. **Add api-company Flux source to Talos** (#90) — needs Talos PR, reference manifests at `flux/api-company-source/`
|
2. **Add api-company Flux source to Talos** (#90) — needs Talos PR, reference manifests at `flux/api-company-source/`
|
||||||
3. **Create `gitea-leeworks-agents-token` secret** in `flux-system` (#76)
|
3. **Create `gitea-leeworks-agents-token` secret** in `flux-system` (#76)
|
||||||
@@ -56,11 +82,12 @@ Legend: [x]=done, [~]=in-progress, [ ]=not started
|
|||||||
6. **All other secrets** (#70, #73, #74, #79, #80, #81, #83) follow in order
|
6. **All other secrets** (#70, #73, #74, #79, #80, #81, #83) follow in order
|
||||||
|
|
||||||
## Blockers — VIN Decoder critical path
|
## Blockers — VIN Decoder critical path
|
||||||
- **P1: #120** — VIN Decoder data layer (NHTSA vPIC SQLite cache) — agent work pending
|
- **P1: #120** — VIN Decoder data layer (NHTSA vPIC SQLite cache) — **agent work, actionable now**
|
||||||
- **P1: #121** — VIN Decoder Fastify server — agent work pending, depends on #120
|
- **P1: #121** — VIN Decoder Fastify server — agent work pending, depends on #120
|
||||||
- **P1: #127** — Create `gitea-registry` imagePullSecret in `vin-decoder` namespace — operator manual task
|
- **P1: #127** — Create `gitea-registry` imagePullSecret in `vin-decoder` namespace — operator manual task
|
||||||
|
- **P2: #126** — Configure `GITEA_TOKEN` secret in `vin-decoder` repo — operator manual task
|
||||||
- **P2: #128** — Create `rapidapi-proxy-secret` in `vin-decoder` namespace — operator manual task
|
- **P2: #128** — Create `rapidapi-proxy-secret` in `vin-decoder` namespace — operator manual task
|
||||||
- **P2: #129** — VIN Decoder Prometheus metrics instrumentation — agent work pending, depends on #121
|
- ~~**P2: #129** — VIN Decoder Prometheus metrics instrumentation~~ — **closed ✅** (PR merged)
|
||||||
- **P3: #139** — Add RAPIDAPI_VIN_* Actions secrets — operator task, depends on RapidAPI listing (#131)
|
- **P3: #139** — Add RAPIDAPI_VIN_* Actions secrets — operator task, depends on RapidAPI listing (#131)
|
||||||
|
|
||||||
## New Issues This Sprint (2026-05-30, #120–#146)
|
## New Issues This Sprint (2026-05-30, #120–#146)
|
||||||
|
|||||||
Reference in New Issue
Block a user