B[Git 브랜치 선택하기] B --> C[한 PR에는 한 언어에 대한 변경사항만] C --> F[기여자 도구 확인하기] end subgraph first[기여 기초] direction TB T[ ] -.- D[문서를 마크다운으로 작성하고 Hugo로 사이트 빌드] --- E[GitHub에 있는 소스] E --- G['/content/../docs' 폴더에 각 언어 컨텐츠가 있음] G --- H[Hugo 페이지 컨텐츠 종류와">
이 섹션에는 새로운 콘텐츠를 기여하기 전에 알아야 할 정보가 있다.
그림 - 새로운 콘텐츠 기여를 위한 준비
위 그림은 새로운 콘텐츠를 제출하기 전에 알아야 할 정보를 설명한다. 해당 정보에 대한 자세한 내용은 다음과 같다.
/content/ko/docs/ 에서 찾을 수 있다.
일부 참조 문서는 update-imported-docs/ 디렉터리의 스크립트를 이용하여
자동으로 생성된다./content/ 에서 여러 언어로 제공된다. 각
언어는 ISO 639-1 표준에
의해 결정된 2문자 코드가 있는 자체 폴더가 있다. 예를 들어,
한글 문서의 소스는 /content/ko/docs/ 에 저장된다.모든 쿠버네티스 기여자는 반드시 기여자 가이드를 읽고 기여자 라이선스 계약(CLA)에 서명해야 한다 .
CLA에 서명하지 않은 기여자의 풀 리퀘스트(pull request)는 자동 테스트에 실패한다.
제공한 이름과 이메일은 git config 에 있는 것과 일치해야 하며,
git 이름과 이메일은 CNCF CLA에 사용된 것과
일치해야 한다.
풀 리퀘스트를 열 때는, 작업의 기반이 되는 브랜치를 미리 알아야 한다.
| 시나리오 | 브랜치 |
|---|---|
| 현재 릴리스의 기존 또는 새로운 영어 콘텐츠 | main |
| 기능 변경 릴리스의 콘텐츠 | dev-<version> 패턴을 사용하여 기능 변경이 있는 주 버전과 부 버전에 해당하는 브랜치. 예를 들어, v1.36 에서 기능이 변경된 경우, dev-1.36 에 문서 변경을 추가한다. |
| 다른 언어로된 콘텐츠(현지화) | 현지화 규칙을 사용. 자세한 내용은 현지화 브랜치 전략을 참고한다. |
어떤 브랜치를 선택해야 할지 모르는 경우 슬랙의 #sig-docs 에 문의한다.
PR 당 하나의 언어로 풀 리퀘스트를 제한한다. 여러 언어로 동일한 코드 샘플을 동일하게 변경해야 하는 경우 각 언어마다 별도의 PR을 연다.
kubernetes/website 리포지터리의
문서 기여자를 위한 도구
디렉터리에는 기여에 도움이 되는 도구들이 있다.