Skip to content

Commit b9efe81

Browse files
kentalowclaude
andauthored
docs: 実装とのドリフト解消・ステータス同期・参照表現の汎用化 (#194)
* docs: 実装とのドリフト解消・ステータス同期・参照表現の汎用化 ドキュメント全体を実装と照合し、ドリフト/陳腐化/内部矛盾を解消する。 実装とのドリフト: - import-logic.md / csv-format.md: notes / alternativeLabel / extensions は 永続化済みなのに「非保存」と記載していた箇所を修正(db-schema.md とも整合) - CSV エクスポートのヘッダー記述を実コードに合わせる(独自 16 列・OpenSALT 13 列、 alternativeLabel / notes / Notes 列、#identifier / #notes メタデータ) - FR-2.5: sort/orderBy/filter/fields は「無視」ではなく実装済み(不正値 400 + X-Total-Count)に修正 ステータス同期: - phases.md / FR: Phase 3 の Discovery・notes 系・OpenSALT Excel round-trip・ GET /CFDocuments クエリパラメータを「完了」に。xlsx / rubric の CLI を FR-10 に追加 - NFR-4.3 を NG-2(認証はスコープ外)と整合。NFR-7.1 をランタイム中立な表現に - deployment.md の alembic 実行コマンドに uv run を付与(コンテナ内で解決可能に) その他: - db-schema.md: tenant.slug、cf_document の package_extensions / definitions_extensions / cf_package_uri_source を追記 - cli.md: ファイル不在時の終了コード差・tenant update の対象オプションを明確化 - 参照表現の汎用化: 下流のデプロイ/管理レイヤーを固有名ではなく汎用表現に統一し、 実装済みで履歴的価値のみの設計メモ cli-command-redesign.md を削除 EN/JA 両面を同期。 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: Codex レビュー指摘の追加ドリフト解消(notes/extensions・rubric 親スコープ UNIQUE) PR #194 のレビューで見つかった残存ドリフト 3 件を修正: - api-spec.md: 「notes / alternativeLabel / extensions は Phase 1 で省略・ Pydantic に含めない」という旧説明を、永続化・往復・API 出力される現状に修正 - db-schema.md: cf_rubric_criterion / cf_rubric_criterion_level を旧グローバル UNIQUE 前提から親スコープ UNIQUE(#187)に修正。cf_item_uri_source 列を追記。 「全テーブルが UNIQUE(tenant_id, identifier)」の記述に親スコープ例外を明記 - import-logic.md: CFRubrics upsert を「identifier 一致」から親スコープ一致 (Criterion=親 CFRubric 内 / Level=親 CFRubricCriterion 内)に明確化。 CSV ルーブリックインポートの Step 4 も同様に明確化 EN/JA 両面を同期。 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent eedaa28 commit b9efe81

12 files changed

Lines changed: 120 additions & 217 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,4 @@ seed/*.csv
4444
!seed/001.csv
4545
!seed/001r.csv
4646
.collaborator
47+
.claude/scheduled_tasks.lock

docs/dev/case-v1p1-conformance-backlog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ compeito の現在のゴールは **OpenCASE / OpenSALT との実用的な相互
3333

3434
## デプロイ上の制約(参考)
3535

36-
- `sort` / `filter` / `fields` / `?strict=1`**動的 API でのみ機能**する。compeito-aws の静的公開は既定応答(未ソート・未フィルタ・全フィールド・非 strict)を焼くため、これらを使うには動的公開が前提。
36+
- `sort` / `filter` / `fields` / `?strict=1`**動的 API でのみ機能**する。静的公開のデプロイでは既定応答(未ソート・未フィルタ・全フィールド・非 strict)を焼くため、これらを使うには動的公開が前提。
3737

3838
## 方針メモ
3939

docs/dev/cli-command-redesign.md

Lines changed: 0 additions & 129 deletions
This file was deleted.

docs/guide/deployment.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ certbot updates the Nginx config to enable HTTPS redirect and auto-renewal.
131131
docker compose -f docker-compose.prod.yml up -d
132132
133133
# Migrate
134-
docker compose -f docker-compose.prod.yml exec app alembic upgrade head
134+
docker compose -f docker-compose.prod.yml exec app uv run alembic upgrade head
135135
136136
# Create a tenant
137137
docker compose -f docker-compose.prod.yml exec app uv run python cli.py tenant create --name "University A"
@@ -242,7 +242,7 @@ git pull
242242
docker compose -f docker-compose.prod.yml up -d --build
243243
244244
# Run migrations if any
245-
docker compose -f docker-compose.prod.yml exec app alembic upgrade head
245+
docker compose -f docker-compose.prod.yml exec app uv run alembic upgrade head
246246
```
247247

248248
## 9. Server migration (with hostname change)
@@ -254,7 +254,7 @@ Restoring a backup carries the data over. If the public hostname changes, you mu
254254
```bash
255255
# 1. Start and migrate on the new server
256256
docker compose -f docker-compose.prod.yml up -d
257-
docker compose -f docker-compose.prod.yml exec app alembic upgrade head
257+
docker compose -f docker-compose.prod.yml exec app uv run alembic upgrade head
258258
259259
# 2. Restore the backup
260260
docker compose -f docker-compose.prod.yml exec -T db psql -U case case < backup.sql
@@ -436,7 +436,7 @@ certbot が Nginx 設定を自動更新し、HTTPS リダイレクトと証明
436436
docker compose -f docker-compose.prod.yml up -d
437437
438438
# マイグレーション
439-
docker compose -f docker-compose.prod.yml exec app alembic upgrade head
439+
docker compose -f docker-compose.prod.yml exec app uv run alembic upgrade head
440440
441441
# テナント作成
442442
docker compose -f docker-compose.prod.yml exec app uv run python cli.py tenant create --name "大学A"
@@ -547,7 +547,7 @@ git pull
547547
docker compose -f docker-compose.prod.yml up -d --build
548548
549549
# マイグレーションがあれば実行
550-
docker compose -f docker-compose.prod.yml exec app alembic upgrade head
550+
docker compose -f docker-compose.prod.yml exec app uv run alembic upgrade head
551551
```
552552

553553
## 9. サーバー引越し(ホスト名変更あり)
@@ -559,7 +559,7 @@ docker compose -f docker-compose.prod.yml exec app alembic upgrade head
559559
```bash
560560
# 1. 新サーバーで起動・マイグレーション
561561
docker compose -f docker-compose.prod.yml up -d
562-
docker compose -f docker-compose.prod.yml exec app alembic upgrade head
562+
docker compose -f docker-compose.prod.yml exec app uv run alembic upgrade head
563563
564564
# 2. バックアップをリストア
565565
docker compose -f docker-compose.prod.yml exec -T db psql -U case case < backup.sql

0 commit comments

Comments
 (0)