쿠버네티스 문서에 기여하기

쿠버네티스는 신규 및 숙련된 모든 기여자의 개선을 환영한다

---

이 웹사이트는 쿠버네티스 SIG Docs에서 관리한다.

쿠버네티스 문서 기여자들은

• 기존 콘텐츠를 개선한다.
• 새 콘텐츠를 만든다.
• 문서를 번역한다.
• 쿠버네티스 릴리스 주기에 맞추어 문서 부분을 관리하고 발행한다.

시작하기

누구든지 문서에 대한 이슈를 오픈 또는 풀 리퀘스트(PR)를 사용해서 kubernetes/website GitHub 리포지터리에 기여할 수 있다. 쿠버네티스 커뮤니티에 효과적으로 기여하려면 git과 GitHub에 익숙해야 한다.

문서에 참여하려면

1. CNCF Contributor License Agreement에 서명한다.
2. 문서 리포지터리와 웹사이트의 정적 사이트 생성기를 숙지한다.
3. 풀 리퀘스트 열기와 변경 검토의 기본 프로세스를 이해하도록 한다.

flowchart TB
subgraph third[PR 열기]
direction TB
U[ ] -.-
Q[컨텐츠 향상시키기] --- N[컨텐츠 생성하기]
N --- O[문서 번역하기]
O --- P[K8s 릴리스 사이클의 문서 파트
관리/퍼블리싱하기]

end

subgraph second[리뷰]
direction TB
   T[ ] -.-
   D[K8s/website
저장소 살펴보기] --- E[Hugo 정적 사이트
생성기 확인하기]
   E --- F[기본 GitHub 명령어
이해하기]
   F --- G[열려 있는 PR을 리뷰하기]
end

subgraph first[가입]
    direction TB
    S[ ] -.-
    B[CNCF
Contributor
License Agreement
서명하기] --- C[sig-docs 슬랙 채널
가입하기] 
    C --- V[kubernetes-sig-docs
메일링 리스트 가입하기]
    V --- M[주간
sig-docs 회의/
슬랙 미팅 참여하기]
end

A([fa:fa-user 신규
기여자]) --> first
A --> second
A --> third
A --> H[질문하기]


classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
class A,B,C,D,E,F,G,H,M,Q,N,O,P,V grey
class S,T,U spacewhite
class first,second,third white

그림 1. 신규 기여자를 위한 시작 가이드.

그림 1은 신규 기여자를 위한 로드맵을 간략하게 보여준다. 가입 및 리뷰 단계의 일부 또는 전체를 따를 수 있다. 이제 PR 열기 아래에 나열된 항목들을 수행하여 당신의 기여 목표를 달성할 수 있다. 다시 말하지만 질문은 언제나 환영한다.

일부 작업에는 쿠버네티스 조직에서 더 많은 신뢰와 더 많은 접근이 필요할 수 있다. 역할과 권한에 대한 자세한 내용은 SIG Docs 참여를 참고한다.

첫 번째 기여

몇 가지 단계를 미리 검토하여 첫 번째 기여를 준비할 수 있다. 그림 2는 각 단계를 설명하며, 그 다음에 세부 사항도 설명되어 있다.

flowchart LR
    subgraph second[첫 기여]
    direction TB
    S[ ] -.-
    G[다른 K8s 멤버의 PR 리뷰하기] -->
    A[K8s/website 이슈 리스트에서
good first issue 확인하기] --> B[PR을 열기]
    end
    subgraph first[추천 준비 사항]
    direction TB
       T[ ] -.-
       D[기여 개요 읽기] -->E[K8s 컨텐츠 및 
스타일 가이드 읽기]
       E --> F[Hugo 페이지 컨텐츠 종류와
shortcode 숙지하기]
    end
    

    first ----> second
     

classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
class A,B,D,E,F,G grey
class S,T spacewhite
class first,second white

그림 2. 첫 기여를 위한 준비.

• 기여 개요를 읽고 기여할 수 있는 다양한 방법에 대해 알아본다.
• kubernetes/website 이슈 목록을 확인하여 좋은 진입점이 되는 이슈를 찾을 수 있다.
• 기존 문서에 대해 GitHub을 사용해서 풀 리퀘스트 열거나 GitHub에서의 이슈 제기에 대해 자세히 알아본다.
• 정확성과 언어에 대해 다른 쿠버네티스 커뮤니티 맴버의 풀 리퀘스트 검토를 한다.
• 쿠버네티스 콘텐츠와 스타일 가이드를 읽고 정보에 대한 코멘트를 남길 수 있다.
• 페이지 콘텐츠 유형과 휴고(Hugo) 단축코드(shortcodes)에 대해 학습한다.

다음 단계

• 리포지터리의 로컬 복제본에서 작업하는 방법을 배운다.

• 릴리스된 기능을 문서화 한다.

• SIG Docs에 참여하고, 멤버 또는 검토자가 된다.

• 현지화를 시작하거나 돕는다.

SIG Docs에 참여

SIG Docs는 쿠버네티스 문서와 웹 사이트를 게시하고 관리하는 기여자 그룹이다. SIG Docs에 참여하는 것은 쿠버네티스 기여자(기능 개발 및 다른 여러가지)가 쿠버네티스 프로젝트에 가장 큰 영향을 미칠 수 있는 좋은 방법이다.

SIG Docs는 여러가지 방법으로 의견을 나누고 있다.

• 쿠버네티스 슬랙 인스턴스에서 #sig-docs 에 가입하고, 자신을 소개한다.
• 더 광범위한 토론이 이루어지고 공식적인 결정이 기록이 되는 kubernetes-sig-docs 메일링 리스트에 가입 한다.
• 2주마다 열리는 SIG Docs 화상 회의에 참여한다. 회의는 항상 #sig-docs 에 공지되며 쿠버네티스 커뮤니티 회의 일정에 추가된다. 줌(Zoom) 클라이언트를 다운로드하거나 전화를 이용하여 전화 접속해야 한다.
• 줌 화상 회의가 열리지 않은 경우, SIG Docs 비실시간 슬랙 스탠드업 회의에 참여한다. 회의는 항상 #sig-docs 에 공지된다. 회의 공지 후 24시간까지 어느 스레드에나 기여할 수 있다.

다른 기여 방법들

• 쿠버네티스 커뮤니티 사이트를 방문한다. 트위터 또는 스택 오버플로우에 참여하고, 현지 쿠버네티스 모임과 이벤트 등에 대해 알아본다.
• 기여자 치트시트를 읽고 쿠버네티스 기능 개발에 참여한다.
• 쿠버네티스 기여자 사이트에서 쿠버네티스 기여자와 추가적인 기여자 리소스에 대해 더 알아본다.
• 블로그 게시물 또는 사례 연구를 제출한다.