[OSSA] 쿠버네티스 한글화 번역 기여 과정

 

과정

1. CNCF Contributor License Agreement에 서명한다. 

- https://github.com/kubernetes-sigs/contributor-playground 해당 프로젝트 Fork하고 PR 올리면 서명하라는 봇이 안내하는대로 서명하면 된다. 

 

2. 여러 가이드를 숙지한다.

- 문서화 가이드 : https://kubernetes.io/docs/contribute/style/style-guide/

Documentation Style Guide

- 한글화 번역 용어집 & 규칙 (Localization Guide) : https://kubernetes.io/ko/docs/contribute/localization_ko/

쿠버네티스 문서 한글화 가이드

예를 들면, Application 을 애플리케이션으로 번역할것인가 어플리케이션으로 번역할 것인가/ 문체는 어떻게 할 것인가에 대해 규칙을 정해두었다. 

 

 

3. https://github.com/kubernetes/website 을 Fork 하고 로컬에 세팅한다. 

GitHub - kubernetes/website: Kubernetes website and documentation repo:

그렇게 되면 기본적으로 fetch/push url 이 {깃헙유저이름}/website.git 이 되게 된다 

 

여기서 fetch, push, pull 의 역할에 대해 알아야 하는데 https://eundms.tistory.com/935 를 참고해보자 

이러한 이유로 로컬에서 push하게 되면 {깃헙유저이름}/website.git에 푸시되게 된다 

 

 

4. kubernetes/website 이슈를 살펴보고 outdated된 한국어 문서 확인해서 이슈를 올리자 

https://github.com/kubernetes/website/issues/

GitHub - kubernetes/website: Kubernetes website and documentation repo:

쿠버네티스 영어 문서와 한국어 문서를 비교하기만 해도 미번역 부분을 찾을 수 있다. 

 

다만, 일거리 찾았다고 바로 번역하면 안된다.

 

아래와 같은 내용으로 Issue를 생성하자 

제목 : [ko] Translate 문서경로 

내용 : 한글화가 되지 않았기 때문

나를 담당자로 지정할 수 있도록 필요한 태그를 코멘트에 적어주자 

/language ko

/assign 

 

그리고 이슈를 확인하게 되면 triage accepted 태그를 달아주신다

그리고 저 진행하고 싶습니다. 라고 하면 /assign 을 받을 수 있고 그 뒤로 진행할 수 있다.

 

 

- 참고 : 이슈 제기하는 좋은 방법 : https://kubernetes.io/ko/docs/contribute/suggesting-improvements/#%EC%9D%B4%EC%8A%88%EB%A5%BC-%EC%A0%9C%EA%B8%B0%ED%95%98%EB%8A%94-%EC%A2%8B%EC%9D%80-%EB%B0%A9%EB%B2%95

콘텐츠 개선 제안하기

 

 

 

+ 참고로 문서화할 때 예제 코드가 링크되어 있다면 해당 예제 코드도 복사해와야 했는데, 만약에 번역이 필요없는 파일의 경우도 복사한다고 하면 예제 파일이 업데이트 되면 원본 파일에서 또 복사해와서 업데이트해야 한다 근데 이런 처리가 안되어 있었다. 

그래서 새로운 이슈를 또 생성했다. 

(예시)

그리고 한글화 기여를 하면서 받은 주요 피드백은 아래와 같다 

- 한국어 문맥에 자연스럽게 번역한다.

- 영문 문서와 한글 문서의 줄 구조를 최대한 동일하게 맞춘다.

- -한다 문체를 사용한다 

- 한국어 문서에서는 문장 끝에 콜론(:) 대신 마침표(.)를 사용하는 것이 좋다.

- 번역된 문서가 링크로 연결되어 있는 경우, 링크 경로를 /{language}/... 형태로 변경하고, 링크 텍스트도 번역된 문서 제목과 동일하게 맞춘다.

- 영문 병기는 문서에서 해당 용어가 처음 등장할 때 한 번만 표기해도 무방하다. 다만 이는 상황에 따라 달라질 수 있다. 

 

 

---

- 참고 : 

https://jinnypark9393.github.io/220710-ossca-kubernetes-docs-localization1/

오픈소스 컨트리뷰션 아카데미(쿠버네티스 한글화) - 쿠버네티스 공식문서 한글화에 기여하는

 

- 인생 첫 오픈소스 프로젝트 PR을 올려봤다 

https://github.com/kubernetes/website/pull/51858

[ko] Translate /tasks/administer-cluster/quota-api-object into Korean by Eundms · Pull Request #51858 · kubernetes/website

 

- 참고자료 : https://kubernetes.io/ko/docs/contribute/

K8s 문서에 기여하기