콘텐츠 개선 제안하기

쿠버네티스 문서에서 문제를 발견하거나 새로운 콘텐츠에 대한 아이디어가 있다면, 이슈를 열어 제안한다. 필요한 것은 GitHub 계정과 웹 브라우저뿐이다.

대부분의 경우, 쿠버네티스 문서에 대한 새로운 작업은 GitHub 이슈에서 시작된다. 쿠버네티스 기여자들은 필요에 따라 이슈를 검토하고 분류하며 태그를 지정한다. 그런 다음 여러분이나 다른 쿠버네티스 커뮤니티 구성원이 이슈를 해결할 변경 사항이 담긴 풀 리퀘스트를 연다.

이슈 열기

기존 콘텐츠를 개선하고 싶거나 오류를 발견했다면, 이슈를 연다.

1. 오른쪽 사이드바에서 이슈 생성 링크를 클릭한다. 그러면 헤더가 미리 채워진 GitHub 이슈 페이지로 이동한다.
2. 문제나 개선 제안을 설명한다. 가능한 한 많은 세부 정보를 제공한다.
3. Submit new issue 버튼을 클릭한다.

이슈를 제출한 뒤에는 가끔 확인하거나 GitHub 알림을 켠다. 리뷰어와 다른 커뮤니티 구성원이 이슈에 조치를 취하기 전에 질문을 남길 수 있다.

새로운 콘텐츠 제안

새로운 콘텐츠에 대한 아이디어는 있지만 어디에 추가해야 할지 확신이 없다면, 이슈를 열어도 된다. 다음 중 하나를 선택한다.

• 콘텐츠가 속한다고 생각되는 섹션의 기존 페이지에서 이슈 생성 링크를 클릭한다.
• GitHub으로 이동해 이슈를 직접 생성한다.

좋은 이슈 작성 방법

이슈를 작성할 때 다음 사항을 명심한다.

• 명확하게 이슈에 대한 설명을 제공한다. 구체적으로 무엇이 누락되었거나, 오래되었거나, 잘못되었거나, 개선이 필요한 사항인지를 설명한다.
• 이 이슈가 사용자에게 미치는 영향을 설명한다.
• 주어진 이슈의 범위를 합리적인 작업 단위로 제한한다. 넓은 범위에 대한 이슈의 경우 더 작은 이슈로 분류한다. 예를 들어, "보안 문서 수정"은 너무 광범위하지만, "'네트워크 접근 제한' 주제에 세부 사항 추가"는 실행할 수 있을 정도로 구체적이다.
• 기존 이슈를 검색하여 새로운 이슈와 관련이 있거나 비슷한 것이 있는지 확인한다.
• 새로운 이슈가 다른 이슈나 풀 리퀘스트와 관련이 있는 경우, 전체 URL이나 # 문자로 시작하는 이슈나 풀 리퀘스트 번호로 참고한다. 예를 들면, Introduced by #987654.
• 행동 강령을 따른다. 동료 기여자를 존중한다. 예를 들어, "문서가 끔찍하다"는 도움이 되지 않거나 예의 바르지 않은 피드백이다.