Skip to content

Commit db82f5a

Browse files
wonyonggseokho-son
andauthored
[ko] Standardize handling of internal links in Korean localization (#53474)
* standardize internal links in Korean localization * Update content/ko/docs/contribute/localization_ko_best_practice.md Co-authored-by: Seokho Son <shsongist@gmail.com> * address review comment * address review comments --------- Co-authored-by: Seokho Son <shsongist@gmail.com>
1 parent 18f529e commit db82f5a

File tree

3 files changed

+37
-12
lines changed

3 files changed

+37
-12
lines changed

content/ko/docs/contribute/localization_ko.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ content_type: concept
4747
지정한다.
4848

4949
한글화팀의 PR 랭글러가 갖는 의무는 업스트림의
50-
[PR 랭글러](/ko/docs/contribute/advanced/#일주일-동안-pr-랭글러-wrangler-되기)가 갖는
50+
[PR 랭글러](/docs/contribute/participate/pr-wranglers)가 갖는
5151
의무와 유사하다. 단, 업스트림의 PR 랭글러와는 달리 승인자가 아니어도 팀 마일스톤의 PR 랭글러가
5252
될 수 있다. 그래서, 보다 상위 권한이 필요한 업무가 발생한 경우, PR 랭글러는 해당 권한을 가진
5353
한글화팀 멤버에게 처리를 요청한다.
5454

55-
업스트림의 [PR 랭글러에게 유용한 GitHub 쿼리](/ko/docs/contribute/advanced/#랭글러에게-유용한-github-쿼리)
55+
업스트림의 [PR 랭글러에게 유용한 GitHub 쿼리](/docs/contribute/participate/pr-wranglers/#랭글러를-위해-도움이-되는-github-쿼리)
5656
기반으로 작성한, 한글화팀의 PR 랭글러에게 유용한 쿼리를 아래에 나열한다.
5757

5858
- [CLA 서명 없음, 병합할 수 없음](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3A%22cncf-cla%3A+no%22+-label%3Ado-not-merge+label%3Alanguage%2Fko)
@@ -121,6 +121,14 @@ content_type: concept
121121
weight: 10
122122
```
123123

124+
### 내부 링크 자동 현지화
125+
쿠버네티스 웹사이트는 문서 빌드 과정에서 `/docs/~`와 같은 형태의 내부 링크 경로 앞에, 문서의 언어에 맞는 디렉터리 접두사(`/ko`)가 자동으로 추가된다.
126+
해당 기능은 풀 리퀘스트 [#47620](https://github.com/kubernetes/website/pull/47620)에서 구현되었으며, 2024년 8월에 병합되었다.
127+
128+
따라서, 현지화 문서 작성 시 다음 기준으로 링크 표기를 통일한다.
129+
* **신규 문서 작성** : 영어 원문의 내부 링크 경로를 변경 없이 유지한다.(단, 앵커 링크의 경우 기존과 같이 한국어에 맞게 수정한다.)
130+
* **기존 문서 갱신** : 과거에 수동으로 추가한 `/ko` 접두사가 남아있는 경우 이를 제거한다.
131+
124132
## 용어 한글화 가이드
125133

126134
### 용어 한글화의 일반적 방침
@@ -199,7 +207,7 @@ API 오브젝트의 필드 이름, 파일 이름, 경로와 같은 내용은 독
199207

200208
### 기능 게이트(feature gate) 한글화 방침
201209

202-
쿠버네티스의 [기능 게이트](/ko/docs/reference/command-line-tools-reference/feature-gates/)
210+
쿠버네티스의 [기능 게이트](/docs/reference/command-line-tools-reference/feature-gates/)
203211
의미하는 용어는 한글화하지 않고 원문 형태를 유지한다.
204212

205213
기능 게이트의 예시는 다음과 같다.
@@ -210,7 +218,7 @@ API 오브젝트의 필드 이름, 파일 이름, 경로와 같은 내용은 독
210218
- ...
211219

212220
전체 기능 게이트 목록은
213-
[여기](/ko/docs/reference/command-line-tools-reference/feature-gates/#feature-gates)를 참고한다.
221+
[여기](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates)를 참고한다.
214222

215223
{{% note %}}
216224
단, 해당 원칙에는 예외가 있을 수 있으며, 이 경우에는 가능한
@@ -393,7 +401,7 @@ Node | 노드(Node) | API 오브젝트인 경우
393401
node lease | 노드 리스(lease)
394402
Object | 오브젝트 |
395403
observability | 가시성(observability) |
396-
Operator | 오퍼레이터 | [쿠버네티스의 소프트웨어 익스텐션](https://kubernetes.io/ko/docs/concepts/extend-kubernetes/operator/)을 의미하는 경우
404+
Operator | 오퍼레이터 | [쿠버네티스의 소프트웨어 익스텐션](/docs/concepts/extend-kubernetes/operator/)을 의미하는 경우
397405
Orchestrate | 오케스트레이션하다 |
398406
Output | 출력 |
399407
parameter | 파라미터 |

content/ko/docs/contribute/localization_ko_best_practice.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,23 @@ content_type: concept
157157

158158
---
159159

160+
### 내부 링크 현지화 가이드라인
161+
162+
- `[xxx](/docs/~)`와 같은 형태의 내부 링크에 언어 디렉터리 접두사(`/ko`)를 수동으로 추가하지 않는다. (참고: 풀 리퀘스트 [#47620](https://github.com/kubernetes/website/pull/47620)에 의해서 자동화 되었음.)
163+
- 기존 문서 수정 과정에서 내부 링크에 `/ko`가 포함되어 있다면 이를 제거한다.
164+
- 단, 원문의 헤더 제목에 별도의 영문 앵커 링크가 지정되어 있는 경우, 해당 앵커의 참조 링크 구문에서도 기존 영문 표기를 유지한다.
165+
헤더 제목에 별도 명시된 영문 앵커가 없고 제목이 한글로 변환되었다면, 헤더 제목에 따라 자동 생성되는 한국어 앵커로 참조 링크 구문도 수정한다.
166+
167+
#### 예시
168+
169+
**[영어 원문]**
170+
> For more information, see \[Adding and removing issue labels\]\(/docs/contribute/review/for-approvers/#adding-and-removing-issue-labels\).
171+
172+
**[권장 번역]**
173+
> 자세한 내용은 \[이슈 레이블 추가와 제거\]\(/docs/contribute/review/for-approvers/#이슈-레이블-추가와-제거\)를 참고한다.
174+
175+
---
176+
160177
## 원문
161178

162179
### 가급적 원문을 준수함
@@ -213,7 +230,7 @@ content_type: concept
213230
### 한글화 용어집에 등록되지 않은 용어
214231

215232
- 쿠버네티스 한글화 팀은 한글화 용어집을 준용하며, 등록되지 않은 용어의 경우 논의를 통해 용어집에 등록할 수 있다.
216-
- 자세한 내용은 [쿠버네티스 한글화 가이드](/ko/docs/contribute/localization_ko/#용어-한글화-가이드)를 참고한다.
233+
- 자세한 내용은 [쿠버네티스 한글화 가이드](/docs/contribute/localization_ko/#용어-한글화-가이드)를 참고한다.
217234

218235
#### 참고 링크
219236
- [용어 논의 관련 사례(#51885)](https://github.com/kubernetes/website/issues/51885#issuecomment-3301329235)
@@ -241,7 +258,7 @@ content_type: concept
241258

242259
### 쿠버네티스 오브젝트 또는 필드 명칭 번역
243260

244-
- [쿠버네티스 문서 한글화 가이드](/ko/docs/contribute/localization_ko/#api-오브젝트-용어-한글화-방침)에서 api 오브젝트 용어 한글화 방침에 대한 내용을 확인할 수 있다.
261+
- [쿠버네티스 문서 한글화 가이드](/docs/contribute/localization_ko/#api-오브젝트-용어-한글화-방침)에서 api 오브젝트 용어 한글화 방침에 대한 내용을 확인할 수 있다.
245262

246263
#### 예시
247264

content/ko/docs/contribute/new-content/open-a-pr.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ card:
1616
{{< /note >}}
1717

1818
새 콘텐츠 페이지를 기여하거나 기존 콘텐츠 페이지를 개선하려면, 풀 리퀘스트(PR)를 연다.
19-
[시작하기 전에](/ko/docs/contribute/new-content/) 섹션의
19+
[시작하기 전에](/docs/contribute/new-content/) 섹션의
2020
모든 요구 사항을 준수해야 한다.
2121

2222
변경 사항이 적거나, git에 익숙하지 않은 경우,
@@ -217,9 +217,9 @@ class changes,changes2 white
217217
- 기존 콘텐츠를 개선하려면, `upstream/main` 를 사용한다.
218218
- 기존 기능에 대한 새로운 콘텐츠를 작성하려면, `upstream/main` 를 사용한다.
219219
- 현지화된 콘텐츠의 경우, 현지화 규칙을 사용한다. 자세한 내용은
220-
[쿠버네티스 문서 현지화](/ko/docs/contribute/localization_ko/)를 참고한다.
220+
[쿠버네티스 문서 현지화](/docs/contribute/localization_ko/)를 참고한다.
221221
- 다가오는 쿠버네티스 릴리스의 새로운 기능에 대해서는 기능 브랜치(feature branch)를 사용한다. 자세한 정보는
222-
[릴리스 문서화](/ko/docs/contribute/new-content/new-features/)를 참고한다.
222+
[릴리스 문서화](/docs/contribute/new-content/new-features/)를 참고한다.
223223
- 콘텐츠 재구성과 같이 여러 SIG Docs 기여자들이 협업하는 장기적인 작업에는,
224224
해당 작업을 위해 작성된 특정 기능 브랜치를 사용한다.
225225

@@ -430,7 +430,7 @@ PR을 연 후, GitHub는 자동화된 테스트를 실행하고
430430
직전의 버전(staged version)이 열린다. 이는 리뷰어가 변경 사항을 확인하는 방법이다.
431431

432432
또한 GitHub는 리뷰어에게 도움을 주기 위해 PR에 레이블을 자동으로 할당한다. 필요한 경우 직접 추가할 수도 있다.
433-
자세한 내용은 [이슈 레이블 추가와 제거](/ko/docs/contribute/review/for-approvers/#이슈-레이블-추가와-제거)를 참고한다.
433+
자세한 내용은 [이슈 레이블 추가와 제거](/docs/contribute/review/for-approvers/#이슈-레이블-추가와-제거)를 참고한다.
434434

435435
### 로컬에서 피드백 해결하기
436436

@@ -634,5 +634,5 @@ PR의 **Commits** 탭에서 또는 `git log` 명령을 로컬에서 실행하여
634634

635635
## {{% heading "whatsnext" %}}
636636

637-
- 리뷰 프로세스에 대한 자세한 내용은 [리뷰하기](/ko/docs/contribute/review/reviewing-prs)를 읽어본다.
637+
- 리뷰 프로세스에 대한 자세한 내용은 [리뷰하기](/docs/contribute/review/reviewing-prs)를 읽어본다.
638638

0 commit comments

Comments
 (0)