docs(fileserver): 파일서버 운영 문서를 한국어로 옮기고 코드와 맞춘다
문제: docs/fileserver 아래 살아 있는 문서 8개가 영어였다(language 예외). 번역하며 본 주장 중 지금 코드와 다른 것이 있었다. - design-deviations.md: 지운 `FileStateMachine`·`FileserverStorageConfiguration`· content-store SPI 넷(`AsyncContentStore` 등)을 지금 있는 것처럼 적었다. 고정 테스트로 없는 `SampleApplicationContextTest`·`LocalOrphanScanAdapterTest`· `FileserverRoundTripContractTest`를 댔다. JPA 저장소가 persistence-jpa에 있다고 했지만 지금은 persistence-fileserver의 `FileserverJpaPersistenceConfig` 조건 하나 뒤에 있다. 지운 reactive transport가 아직 스트리밍한다고 했다. - security.md: 「익명 읽기를 켜면」이라고 했지만 설정 스위치가 없다 (`FileserverSecurityConfiguration`이 늘 false로 만든다). 이름 `ContentDispositionFactory`는 지금 `HttpContentDispositionFactory`다. - upgrade-guide.md: batch 실패를 `results[].problem`으로, 결과 모름을 problem document로 읽으라고 했다. 지금은 `results[].error`와 Envelope `error.details.ambiguous`다. 확인 명령이 Fileserver 테스트가 없는 `:app-bootstrap:test --tests '*Fileserver*'`와 fileserver 코드가 없는 `:application-core:check`·`:adapter:inbound:web:check`를 돌렸다. - operations.md: 「NFS 결과 모름」 신호를 problem document로 적었다(지금은 Envelope). 고친 방법: 뜻을 그대로 옮기고 식별자·명령·경로·표 구조는 원문으로 둔다. 지원 등급 이름(Stable, Beta, Limited, Compatibility, Experimental)은 표와 테스트가 읽는 꼬리표라 원문으로 둔다(messaging 지원 매트릭스와 같다). configuration.md의 절 제목은 테스트가 읽는 「… — `key`」 꼴을 지킨다. 위 불일치는 코드에 맞춰 고쳤다. 테스트: FileserverDocumentationCoverageTest가 runbook 제목 일곱과 「Explicitly not claimed」를 영어 문자열로 단언했다. 같은 계약(runbook마다 제목이 있고, 주장하지 않는 것을 따로 밝힌다)을 한국어 제목 `## 저장소 가득 참` 등과 `## 주장하지 않는 것`으로 단언한다. 제목 앞에 `## `를 붙여 본문 어딘가에 낱말만 있어도 통과하던 것을 제목으로 좁혔다. metric 이름·CI job·endpoint·설정 key 단언은 그대로다. 버린 대안: runbook 제목을 영어로 남기기. 살아 있는 문서를 한국어로 쓴다는 소유자 결정과 맞지 않는다. 위험·한계: 내용 감사는 하지 않았다. 번역하며 본 불일치만 고쳤다. 검증: python3 scripts/check-docs.py rc=0(이 폴더 예외 줄 0). 테스트의 단언을 같은 정규식으로 문서에 돌려 보았다(runbook 제목·job 존재·설정 key 44개가 번역 전과 같음).
This commit is contained in:
+11
-10
@@ -68,13 +68,13 @@ class FileserverDocumentationCoverageTest {
|
||||
|
||||
List<String> requiredRunbooks =
|
||||
List.of(
|
||||
"Storage full",
|
||||
"Orphan growth",
|
||||
"Verification backlog",
|
||||
"NFS ambiguity",
|
||||
"PVC remount",
|
||||
"Nginx delegation failure",
|
||||
"Cleanup backlog");
|
||||
"## 저장소 가득 참",
|
||||
"## 고아 객체 증가",
|
||||
"## 검증 적체",
|
||||
"## NFS 결과 모름",
|
||||
"## PVC 다시 마운트",
|
||||
"## Nginx 위임 실패",
|
||||
"## 정리 적체");
|
||||
|
||||
assertThat(requiredRunbooks).allSatisfy(runbook -> assertThat(operations).contains(runbook));
|
||||
assertThat(operations)
|
||||
@@ -91,7 +91,7 @@ class FileserverDocumentationCoverageTest {
|
||||
|
||||
assertThat(matrix)
|
||||
.as("an omitted capability reads as an unstated claim; absence must be explicit")
|
||||
.contains("Explicitly not claimed")
|
||||
.contains("## 주장하지 않는 것")
|
||||
.contains("ReadWriteMany");
|
||||
}
|
||||
|
||||
@@ -143,8 +143,9 @@ class FileserverDocumentationCoverageTest {
|
||||
* Table keys from the configuration reference, minus the ones already qualified by a section.
|
||||
*
|
||||
* <p>The document writes a bare key inside a per-section table (for example {@code root} under
|
||||
* "Storage") and a qualified one elsewhere ({@code upload.ttl}); only the qualified form can be
|
||||
* bound without reconstructing the section context, so the bare ones are read with their heading.
|
||||
* the {@code storage} heading) and a qualified one elsewhere ({@code upload.ttl}); only the
|
||||
* qualified form can be bound without reconstructing the section context, so the bare ones are
|
||||
* read with their heading.
|
||||
*/
|
||||
private static List<String> documentedSettingKeys(Path configuration) throws IOException {
|
||||
List<String> keys = new ArrayList<>();
|
||||
|
||||
Reference in New Issue
Block a user