문제: `docs/runbooks`의 runbook 38개가 영어였다(`check-docs.py` language
예외). 머리말 `status`는 `stub`·`active`였는데 문서 체계 규칙(design-docs
`conventions/docs-system.md` 1절)은 runbook 상태를 「초안 · 운영」으로 정한다.
번역하며 대조하니 지금 코드와 다른 주장도 있었다.
고친 것:
- 38개를 번역했다. 코드·명령·경로·설정 키·로그 문자열·표 구조는 그대로다.
lane이 읽는 SQL·Redis 블록과 표지(`<!-- runbook-sql: … -->`)는 바이트 그대로다.
- `status`: stub → 초안 43개, active → 운영 3개, `template.md`는 `<초안|운영>`.
머리말이 없는 gRPC runbook 둘은 그대로다.
- 코드에 맞춘 주장:
- adapter-adapter-disabled: 없는 `adapter_name` 로그 칸 → `ServerFailureLog`의
`failure classified as ADAPTER_DISABLED` 줄과 예외 메시지. 지금 이 코드를 내는
곳은 `RoutingNotifier`뿐이다.
- startup-required-adapter-disabled: `startup.phase=adapter-check` →
`adapter-enablement`(`StartupPhase.ADAPTER_ENABLEMENT`).
- cache-stampede-lock-timeout·cache-unavailable·file-download-streaming-failure:
그 코드는 `error-codes.yaml`에 없고 어느 코드도 내지 않는다고 밝혔다.
- db-idle-in-tx-timeout: 없는 `spring.jpa.properties.hibernate.connection.timeout`
→ `app.persistence-jpa.transaction.*`. db-query-canceled에 남은 시간 전달을 더했다.
- dependency-timeout: 「기본 전체 10s」 → profile `timeout.total-call`
(`HttpClientPlatformSettings` 기본 `4s`, 값은 configuration-reference를 가리킨다).
- management-actuator-forbidden: 없는 break-glass runbook → 노출 제외 목록
(`config/observability.yml`).
- runtime-jvm-oom: 아무것도 쓰지 않는 `error.code=JVM_OOM` 로그를 지우고, 힙 덤프
경로(`src/Dockerfile`)를 적었다.
- auth-public-path-misconfiguration: 공개 경로는 `config/security.yml` `public-paths`.
- grpc-advanced-capabilities: 지운 `GrpcAdvancedSupportMatrix` →
`GrpcAdvancedCapability.defaultGrade()`, envoy 참조 설정의 실제 경로.
- grpc-platform-operations: 없는 `runtime_memberships` → registry `"build": "optional-grpc"`.
- 다른 문서·코드가 영어 절 제목으로 인용하는 곳("Recover a failed concurrent index
migration", "Classify the failure")은 한국어 제목 뒤 괄호에 영어를 남겼다. 인용하는
쪽(테스트 fixture 메시지, `docs/upgrade`, 다른 세션 범위 문서)은 고치지 않아도 맞다.
- `RunbookCoverageContractTest`: `초안`을 초안으로 보고, 머리말 `status`가 `초안`·`운영`
밖이면 실패하는 테스트를 더했다.
- `scripts/check-docs-exceptions.txt`에서 runbook language 줄 38개를 지웠다.
버린 대안: 옛 `stub`도 초안으로 계속 받기. 그러면 옛 표기로 쓴 초안이 운영
runbook으로 통과한다. 어휘 밖 값을 실패로 둬야 그 길이 막힌다.
위험·한계:
- 이미 한국어였던 runbook 11개는 `status`만 바꿨고 본문 감사는 하지 않았다.
- runtime-jvm-oom의 「종료 코드 137」은 원문대로 두었다. JVM의
`-XX:+ExitOnOutOfMemoryError` 종료 코드는 3이고 137은 SIGKILL이라 확인이 필요하다.
- `docs/mongodb/runbooks/*.md`의 `status: active`는 이 테스트 밖이고 범위 밖이라 두었다.
검증: 아래 「검증」 줄은 영역 커밋 여섯이 합쳐진 최종 트리에서 돌렸다.
검증(desktop, 최종 트리 8295db89 = 이 묶음 마지막 커밋의 트리. 로그
`~/d2c-ops-docs-1-logs/`):
- `:app-bootstrap:documentContractTest` rc=0, 68개 실패 0(`RunbookCoverageContractTest` 7개).
`:app-bootstrap:repositoryContractTest` rc=0, 65개 건너뜀 1(원래 그렇다) 실패 0.
- runbook SQL·Redis 블록을 문서에서 읽는 lane: persistence-jpa
`postgresqlConcurrentIndexMigrationIntegrationTest`·`postgresqlDistributedLockIntegrationTest`·
`postgresqlOutboxOrderKeyRunbookIntegrationTest`·`postgresqlOutboxDispositionRunbookIntegrationTest`
rc=0(35개 실패 0), cache-redis `redisContainerContractTest` rc=0(103개 실패 0),
`:composition:outbox-relay:mainCheck` rc=0. 모두 실행됨(FROM-CACHE는 다른 leaf의 main 컴파일뿐).
- RED: 새 테스트를 기준 커밋의 옛 runbook에 대면 `legacyStubDebtMustMatchEveryAndOnlyCurrentStubRunbook`과
`everyRunbookFrontmatterDeclaresDraftOrOperatingStatus`가 실패한다("status=stub").
- `:app-bootstrap:spotlessCheck checkstyleTest testQualityCheck` rc=0.
- 커밋마다(노트북): `python3 scripts/check-docs.py` rc=0, `python3 -m unittest discover -s scripts/tests` rc=0.
182 lines
9.5 KiB
Plaintext
182 lines
9.5 KiB
Plaintext
# scripts/check-docs.py의 예외 목록. 2026-11-07 기준선이고 줄기만 한다.
|
|
#
|
|
# - 이 목록에 새 줄을 더하면 검사가 실패한다. 줄마다 check-docs.py의 FROZEN에 지문이 있어야 한다.
|
|
# - 번역하거나 고쳐서 더는 걸리지 않는 줄은 지운다. 남겨 두면 검사가 실패한다.
|
|
# - 형식: <검사><탭><경로>[<탭><걸린 값>]. 「#」으로 시작하는 줄과 빈 줄은 읽지 않는다.
|
|
|
|
# 언어: 아직 한국어로 옮기지 않은 살아 있는 문서와 ADR. 다음 단계(살아 있는 문서 번역, ADR 번역)에서 지운다.
|
|
language .github/dependency-vulnerability-policy.md
|
|
language .github/pull_request_template.md
|
|
language compose/keycloak/README.md
|
|
language compose/redis/acl/README.md
|
|
language docs/adr/ADR-BUILD-001-one-convention-for-shared-test-code.md
|
|
language docs/adr/ADR-GQL-001-graphql-context-and-storage-ownership.md
|
|
language docs/adr/ADR-GRPC-001-platform-family-and-registry-shape.md
|
|
language docs/adr/ADR-GRPC-002-schema-governance-without-protoc.md
|
|
language docs/adr/ADR-GRPC-003-three-axis-execution-evidence.md
|
|
language docs/adr/ADR-GRPC-004-retry-ownership-and-durable-idempotency.md
|
|
language docs/adr/ADR-GRPC-005-server-streaming-single-writer-and-resume.md
|
|
language docs/adr/ADR-GRPC-006-stable-discovery-and-kubernetes-routing.md
|
|
language docs/adr/ADR-GRPC-ADV-001-capability-promotion-is-per-capability.md
|
|
language docs/adr/ADR-JPA-001-domain-owns-persistence-model.md
|
|
language docs/adr/ADR-JPA-002-full-transaction-retry.md
|
|
language docs/adr/ADR-JPA-003-completion-unknown.md
|
|
language docs/adr/ADR-JPA-004-flyway-schema-source-of-truth.md
|
|
language docs/adr/ADR-JPA-005-postgresql-real-contract.md
|
|
language docs/adr/ADR-JPA-006-canonical-technical-audit.md
|
|
language docs/adr/ADR-MONGO-001-platform-boundary.md
|
|
language docs/adr/ADR-MONGO-002-bson-representation.md
|
|
language docs/adr/ADR-MONGO-003-transaction-retry.md
|
|
language docs/adr/ADR-MONGO-004-index-schema-admin-plane.md
|
|
language docs/adr/ADR-MONGO-ADV-001-capability-promotion.md
|
|
language docs/adr/ADR-WEB-ADV-001-streaming-is-live-delivery.md
|
|
language docs/adr/ADR-WEB-ADV-002-virtual-threads-do-not-remove-admission.md
|
|
language docs/adr/ADR-WEB-ADV-003-openapi-32-remains-experimental.md
|
|
language docs/adr/ADR-WS-001-platform-as-packages-and-its-boundaries.md
|
|
language docs/adr/ADR-WS-002-resume-and-cluster.md
|
|
language docs/adr/ADR-WS-003-stomp-and-broker-relay.md
|
|
language docs/compatibility/grpc-advanced-support-matrix.md
|
|
language docs/compatibility/grpc-support-matrix.md
|
|
language docs/fileserver/configuration.md
|
|
language docs/fileserver/design-deviations.md
|
|
language docs/fileserver/http-contract.md
|
|
language docs/fileserver/operations.md
|
|
language docs/fileserver/security.md
|
|
language docs/fileserver/storage-certification.md
|
|
language docs/fileserver/support-matrix.md
|
|
language docs/fileserver/upgrade-guide.md
|
|
language docs/httpclient/configuration-reference.md
|
|
language docs/httpclient/operations.md
|
|
language docs/httpclient/performance-baseline.md
|
|
language docs/httpclient/release-checklist.md
|
|
language docs/httpclient/repository-adaptation.md
|
|
language docs/httpclient/retry-and-ambiguity.md
|
|
language docs/httpclient/security.md
|
|
language docs/httpclient/streaming.md
|
|
language docs/httpclient/support-matrix.md
|
|
language docs/jpa/batch-write-guide.md
|
|
language docs/jpa/entity-mapping-guide.md
|
|
language docs/jpa/experimental-promotion-checklist.md
|
|
language docs/jpa/experimental-support-matrix.md
|
|
language docs/jpa/migration-guide.md
|
|
language docs/jpa/observability.md
|
|
language docs/jpa/postgresql-extensions.md
|
|
language docs/jpa/query-fetch-guide.md
|
|
language docs/jpa/repository-adaptation.md
|
|
language docs/jpa/runbooks.md
|
|
language docs/jpa/support-matrix.md
|
|
language docs/jpa/transaction-guide.md
|
|
language docs/mongodb/advanced/encryption.md
|
|
language docs/mongodb/advanced/multi-tenancy.md
|
|
language docs/mongodb/advanced/sharding.md
|
|
language docs/mongodb/advanced/signoff/README.md
|
|
language docs/mongodb/bson-mapping-guide.md
|
|
language docs/mongodb/consistency-transaction-guide.md
|
|
language docs/mongodb/document-modeling-guide.md
|
|
language docs/mongodb/query-aggregation-guide.md
|
|
language docs/mongodb/repository-adaptation.md
|
|
language docs/mongodb/runbooks/failover.md
|
|
language docs/mongodb/runbooks/unknown-commit.md
|
|
language docs/mongodb/schema-index-migration-guide.md
|
|
language docs/mongodb/security-observability.md
|
|
language docs/mongodb/support-matrix.md
|
|
language docs/notification/adr/NOTIF-ADR-001-durable-acceptance.md
|
|
language docs/notification/adr/NOTIF-ADR-002-event-ledger-projection.md
|
|
language docs/notification/adr/NOTIF-ADR-003-ambiguous-submission.md
|
|
language docs/notification/adr/NOTIF-ADR-004-fcm-fid-primary.md
|
|
language docs/notification/at-rest-threat-model.md
|
|
language docs/notification/callback-reconciliation.md
|
|
language docs/notification/configuration-reference.md
|
|
language docs/notification/delivery-evidence.md
|
|
language docs/notification/migration-guide.md
|
|
language docs/notification/module-mapping.md
|
|
language docs/notification/operations.md
|
|
language docs/notification/provider-runbooks.md
|
|
language docs/notification/security-privacy.md
|
|
language docs/notification/support-matrix.md
|
|
language docs/observability/log-fields.md
|
|
language docs/redis/command-policy.md
|
|
language docs/redis/operations.md
|
|
language docs/redis/support-matrix.md
|
|
language docs/redis/upgrade-guide.md
|
|
language docs/storage-capability-boundary.md
|
|
language docs/web/advanced-capabilities.md
|
|
language docs/web/openapi-32-compatibility.md
|
|
language docs/web/patch-contract.md
|
|
language docs/web/repository-adaptation.md
|
|
language docs/web/runbook.md
|
|
language docs/web/streaming-contract.md
|
|
language docs/web/virtual-thread-profile.md
|
|
language docs/websocket/runbook.md
|
|
language src/adapter/inbound/messaging/CLAUDE.md
|
|
language src/adapter/inbound/web-advanced/CLAUDE.md
|
|
language src/adapter/inbound/web/CLAUDE.md
|
|
language src/adapter/inbound/websocket/CLAUDE.md
|
|
language src/adapter/outbound/cache-redis/CLAUDE.md
|
|
language src/adapter/outbound/cache-redis/README.md
|
|
language src/adapter/outbound/fileserver/CLAUDE.md
|
|
language src/adapter/outbound/fileserver/README.md
|
|
language src/adapter/outbound/httpclient/CLAUDE.md
|
|
language src/adapter/outbound/httpclient/README.md
|
|
language src/adapter/outbound/identifier/CLAUDE.md
|
|
language src/adapter/outbound/messaging-kafka/CLAUDE.md
|
|
language src/adapter/outbound/messaging/CLAUDE.md
|
|
language src/adapter/outbound/notification/CLAUDE.md
|
|
language src/adapter/outbound/objectstorage/CLAUDE.md
|
|
language src/adapter/outbound/objectstorage/README.md
|
|
language src/adapter/outbound/persistence-fileserver/CLAUDE.md
|
|
language src/adapter/outbound/persistence-jpa/CLAUDE.md
|
|
language src/adapter/outbound/persistence-mongo/CLAUDE.md
|
|
language src/adapter/outbound/persistence-notification/CLAUDE.md
|
|
language src/adapter/outbound/redis-sdk/README.md
|
|
language src/adapter/outbound/redis-sdk/compose/README.md
|
|
language src/adapter/outbound/support/CLAUDE.md
|
|
language src/app-bootstrap/CLAUDE.md
|
|
language src/app-bootstrap/src/test/resources/developer-experience/broken-readme.md
|
|
language src/application-core/CLAUDE.md
|
|
language src/build-logic/README.md
|
|
language src/composition/outbox-relay/CLAUDE.md
|
|
language src/config/architecture/README.md
|
|
language src/domain-core/CLAUDE.md
|
|
language src/platforms/optional-build/README.md
|
|
language src/shared-contract/CLAUDE.md
|
|
|
|
# 참조: 지금 트리·registry에 없는 경로. 고치거나 「> 이력」 인용 블록으로 옮기면 지운다.
|
|
reference AGENTS.md src/build-tools/
|
|
reference docs/mongodb/consumer-leaf-guide.md :adapter:outbound:persistence-note:check
|
|
reference docs/web/http-contract.md docs/architecture/backend-api-and-server-state-contract.md
|
|
reference docs/work/operate.md :a:test
|
|
reference docs/work/operate.md :b:test
|
|
reference src/README.md .github/ci-gate-matrix.yml
|
|
reference src/README.md .github/scripts/verify-gate-matrix.sh
|
|
|
|
# 숫자: 정본(src/gradle/libs.versions.toml, registry)이 정하는 값을 복사한 곳. 정본을 가리키게 고치면 지운다.
|
|
number docs/compatibility/grpc-support-matrix.md Spring Boot 4.0.8
|
|
number docs/httpclient/repository-adaptation.md 19 leaf
|
|
number docs/httpclient/repository-adaptation.md Spring Boot 4.0.8
|
|
number docs/jpa/repository-adaptation.md 19 leaf
|
|
number docs/jpa/repository-adaptation.md Spring Boot 4.0.8
|
|
number docs/manual/01-generator.md 5 leaf
|
|
number docs/mongodb/repository-adaptation.md 19 leaf
|
|
number docs/mongodb/repository-adaptation.md Spring Boot 4.0.8
|
|
number src/adapter/inbound/graphql/CLAUDE.md Spring Boot 4.0.0
|
|
number src/adapter/inbound/graphql/README.md 19개 leaf
|
|
number src/adapter/inbound/graphql/README.md 24개 leaf
|
|
number src/adapter/inbound/graphql/README.md 43개 leaf
|
|
number src/adapter/inbound/grpc/CLAUDE.md Spring Boot 4.0.0
|
|
number src/adapter/inbound/web/CLAUDE.md Spring Boot 4.0.0
|
|
number src/adapter/inbound/websocket/CLAUDE.md Spring Boot 4.0.8
|
|
number src/adapter/outbound/cache-redis/CLAUDE.md Spring Boot 4.0.0
|
|
number src/adapter/outbound/fileserver/CLAUDE.md Spring Boot 4.0.0
|
|
number src/adapter/outbound/httpclient/CLAUDE.md Spring Boot 4.0.0
|
|
number src/adapter/outbound/identifier/CLAUDE.md Spring Boot 4.0.8
|
|
number src/adapter/outbound/messaging/CLAUDE.md Spring Boot 4.0.8
|
|
number src/adapter/outbound/notification/CLAUDE.md Spring Boot 4.0.0
|
|
number src/adapter/outbound/objectstorage/CLAUDE.md Spring Boot 4.0.0
|
|
number src/adapter/outbound/persistence-jpa/CLAUDE.md Spring Boot 4.0.0
|
|
number src/adapter/outbound/persistence-mongo/CLAUDE.md Spring Boot 4.0.0
|
|
number src/adapter/outbound/support/CLAUDE.md Spring Boot 4.0.0
|
|
number src/app-bootstrap/CLAUDE.md Spring Boot 4.0.0
|
|
number src/domain-core/CLAUDE.md Spring Boot 4.0.0
|
|
number src/shared-contract/CLAUDE.md Spring Boot 4.0.0
|