CodeForPhilly / CodeForPhilly/codeforphilly-ng
docs: document operator-facing scripts (cutover-dry-run, cutover-mailout, reconcile, setup-dev-data)
- Ngôn ngữ chính
- TypeScript
- Star
- 1
- Fork
- 1
- Merge trung bình
- 5 ngày 3 giờ
- Pull request đã merge (30 ngày)
- 9
Mô tả
## Gap
Four \`apps/api/scripts/*\` operator-facing scripts exist with no doc entry in \`docs/operations/\` or the relevant spec:
| Script | What it does | Where it should be documented |
|---|---|---|
| \`cutover-dry-run.ts\` | Walks the full cutover pipeline against a non-prod target — used during T-3 staging rehearsal | \`docs/operations/cutover.md\` (T-3 section) |
| \`cutover-mailout.ts\` | Sends T+90 unclaimed-account reminder emails | \`docs/operations/cutover.md\` (T+90 section) or \`specs/behaviors/account-migration.md\` |
| \`reconcile.ts\` | Walks Person records and flags private-store orphans (used at cutover + ongoing) | \`docs/operations/runbook.md\` (maintenance) — referenced once in \`specs/behaviors/private-storage.md:99\` but no operator instructions |
| \`setup-dev-data.ts\` | Seeds gitsheets with minimal sheet configs for local boot | \`specs/architecture.md\` Build/dev section + \`CLAUDE.md\` local setup |
## Why it matters
Pre-cutover, the staging rehearsal (#54) needs operators to know these exist + how to invoke them. Local-setup contributors hit \`setup-dev-data.ts\` on first run and may not know what they're running.
Identified during the 2026-05-30 post-cutover-blog spec-drift audit.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Hướng nghiên cứu
Bắt đầu bằng cách đọc apps/api/scripts/cutover-dry-run.ts, cutover-mailout.ts, reconcile.ts và setup-dev-data.ts, sau đó đối chiếu chúng với docs/operations/cutover.md, docs/operations/runbook.md, specs/behaviors/account-migration.md, specs/behaviors/private-storage.md, specs/architecture.md và CLAUDE.md. Ghi lại mục đích, cách gọi và bối cảnh vận hành của từng script tại các vị trí được issue nêu, bao gồm cả tham chiếu hiện có đến private-storage. Hoàn thành có nghĩa là các operator có thể tìm và hiểu cả bốn script phục vụ cutover, bảo trì và thiết lập cục bộ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- typescript
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 76/100