K8s 문서 기여하기

Contribute to Kubernetes docs

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

쿠버네티스 문서 또는 웹사이트에 기여하여 도움을 제공하고 싶다면, 우리는 당신의 도움을 기쁘게 생각한다! 당신이 새로운 프로젝트에 참여했거나 오랜 시간 동안 진행해온 누군가로써, 혹은 개발자, 최종 사용자 또는 단지 오타를 보고 참지 못하는 누군가로써 기여할 수 있다.

쿠버네티스 문서 내용과 스타일에 대해 더 많은 정보를 알고 싶다면, 문서 스타일 개요를 참고하자.

1 문서 컨트리뷰터 유형

• 쿠버네티스 조직의 멤버 는 CLA에 서명하고, 프로젝트에 어느 정도 시간과 노력을 바친 사람이다. 멤버십 자격에 대한 구체적인 기준은 커뮤니티 멤버십을 참고하라.
• SIG Docs 리뷰어 는 문서 풀 리퀘스트(pull request) 리뷰하는 일에 관심을 보여서 SIG Docs 승안자가 적합한 GitHub 그룹 및 저장소 내 그룹과 OWNERS 파일에 등록한 쿠버네티스 조직의 멤버이다.
• SIG Docs 승인자 는 지속적으로 프로젝트에 기여를 해온 좋은 입지를 가진 멤버이다. 승인자는 풀 리퀘스트를 머지(merge)할 수 있고, 쿠버네티스 조직을 대표하여 콘텐츠를 공개한다. 승인자는 거대한 쿠버네티스 커뮤니티에서 SIG Docs를 대표할 수 있다. SIG Docs 승인자의 의무 중 릴리스 조정과 같은 일은 상당한 시간을 필요로 한다.

2 문서화에 기여할 수 있는 방법

이 목록은 누구나 할 수 있는 일, 쿠버네티스 조직 멤버가 할 수 있는 일, 그리고 SIG Docs 프로세스의 더 높은 레벨의 접근과 친숙함을 요구하는 일로 나누어졌다. 지속적으로 기여를 하는 것은 이미 만들어진 도구(tooling)와 조직의 결정을 이해하는데 도움이 될 것이다.

이것은 쿠버네티스 문서에 기여하는 완전한 방법은 아니지만, 시작하는 데에 도움이 될 것이다.

• 누구나
  • 조치 가능한 이슈 열기
• 멤버
  • 기존 문서 개선
  • Slack 또는 SIG docs 메일링 리스트에서 개선을 위한 아이디어 제시
  • 문서 접근성 개선
  • PR에 대한 구속력 없는 피드백 제공
  • 블로그 포스트 또는 사례 연구 작성
• 리뷰어
  • 새로운 기능 문서화
  • 이슈 선별 및 분류
  • PR 리뷰
  • 다이어그램, 그래픽 자료, 내장 스크린샷 생성
  • 현지화(Localization)
  • docs 대표로 다른 저장소에 기여
  • 코드 내 사용자 대면 문자열 편집
  • 코드 주석 및 Godoc 개선
• 승인자
  • 승인되어 머지된 PR을 바탕으로 컨트리뷰터 콘텐츠 출시
  • docs 대표로 쿠버네티스 릴리스 팀에 참가
  • 스타일 가이드 개선 제안
  • 문서 테스트 개선 제안
  • 쿠버네티스 website 또는 기타 도구(tooling) 개선 제안

3 추가적인 기여 방법

• 트위터나 스택오버플로(Stack Overflow) 등의 온라인 포럼의 쿠버네티스 커뮤니티에 기여하거나 지역 모임과 쿠버네티스 이벤트에 관하여 알고 싶다면 쿠버네티스 커뮤니티 사이트를 확인한다.
• 기능 개발에 기여하려면 기여자 치트시트를 읽고 시작한다.

4 참고

• https://kubernetes.io/ko/docs/contribute/
• https://kubernetes.io/docs/contribute/
• https://github.com/kubernetes/website/blob/master/content/ko/docs/contribute/_index.md