From 4d9dc64f95e42c7b96f1ca03092bbf813c5a8a51 Mon Sep 17 00:00:00 2001 From: bconfiden2 Date: Tue, 10 Jan 2023 12:14:58 +0900 Subject: [PATCH] Update outdated files in dev-1.26-ko.1 (M98-M108) --- content/ko/docs/contribute/advanced.md | 2 +- content/ko/docs/contribute/analytics.md | 2 +- .../contribute/generate-ref-docs/_index.md | 2 +- .../generate-ref-docs/quickstart.md | 6 ++- .../participate/roles-and-responsibilities.md | 4 +- .../docs/contribute/review/for-approvers.md | 8 ++-- .../docs/contribute/review/reviewing-prs.md | 44 +++++++++++++++++-- .../docs/contribute/style/write-new-topic.md | 4 +- content/ko/docs/reference/_index.md | 5 ++- .../reference/access-authn-authz/_index.md | 2 +- .../access-authn-authz/kubelet-authn-authz.md | 1 + 11 files changed, 60 insertions(+), 20 deletions(-) diff --git a/content/ko/docs/contribute/advanced.md b/content/ko/docs/contribute/advanced.md index 047dfe37a8..6d2fcc4d32 100644 --- a/content/ko/docs/contribute/advanced.md +++ b/content/ko/docs/contribute/advanced.md @@ -2,7 +2,7 @@ title: 고급 기여 slug: advanced content_type: concept -weight: 98 +weight: 100 --- diff --git a/content/ko/docs/contribute/analytics.md b/content/ko/docs/contribute/analytics.md index d96d1ed576..d4e83ab5a9 100644 --- a/content/ko/docs/contribute/analytics.md +++ b/content/ko/docs/contribute/analytics.md @@ -1,7 +1,7 @@ --- title: 사이트 분석 보기 content_type: concept -weight: 100 +weight: 120 card: name: contribute weight: 100 diff --git a/content/ko/docs/contribute/generate-ref-docs/_index.md b/content/ko/docs/contribute/generate-ref-docs/_index.md index ad9d221f15..e08c387c83 100644 --- a/content/ko/docs/contribute/generate-ref-docs/_index.md +++ b/content/ko/docs/contribute/generate-ref-docs/_index.md @@ -1,5 +1,5 @@ --- -title: 레퍼런스 문서 개요 +title: 레퍼런스 문서 갱신하기 main_menu: true weight: 80 --- diff --git a/content/ko/docs/contribute/generate-ref-docs/quickstart.md b/content/ko/docs/contribute/generate-ref-docs/quickstart.md index 775c7ed77a..24091ce8e6 100644 --- a/content/ko/docs/contribute/generate-ref-docs/quickstart.md +++ b/content/ko/docs/contribute/generate-ref-docs/quickstart.md @@ -1,7 +1,9 @@ --- -title: 퀵스타트 가이드 +title: 레퍼런스 문서 퀵스타트 가이드 +linkTitle: Quickstart content_type: task -weight: 40 +weight: 10 +hide_summary: true --- diff --git a/content/ko/docs/contribute/participate/roles-and-responsibilities.md b/content/ko/docs/contribute/participate/roles-and-responsibilities.md index f816a12191..23201553f9 100644 --- a/content/ko/docs/contribute/participate/roles-and-responsibilities.md +++ b/content/ko/docs/contribute/participate/roles-and-responsibilities.md @@ -102,7 +102,7 @@ GitHub 계정을 가진 누구나 쿠버네티스에 기여할 수 있다. SIG D ## 리뷰어 리뷰어는 열린 풀 리퀘스트를 리뷰할 책임이 있다. 멤버 피드백과는 달리, -여러분은 리뷰어의 피드백을 반드시 해결해야 한다. 리뷰어는 +PR 작성자는 리뷰어의 피드백을 반드시 해결해야 한다. 리뷰어는 [@kubernetes/sig-docs-{language}-reviews](https://github.com/orgs/kubernetes/teams?query=sig-docs) GitHub 팀의 멤버이다. @@ -192,7 +192,7 @@ PR은 자동으로 병합된다. SIG Docs 승인자는 추가적인 기술 리 {{< /warning >}} - 제안된 변경이 - [컨트리뷰션 가이드 라인](/docs/contribute/style/content-guide/#contributing-content)에 적합한지 확인한다. + [컨트리뷰션 가이드 라인](/docs/contribute/style/content-guide/)에 적합한지 확인한다. 질문이 생기거나 확실하지 않다면 자유롭게 추가 리뷰를 요청한다. diff --git a/content/ko/docs/contribute/review/for-approvers.md b/content/ko/docs/contribute/review/for-approvers.md index 3ded883231..1e49d02cf0 100644 --- a/content/ko/docs/contribute/review/for-approvers.md +++ b/content/ko/docs/contribute/review/for-approvers.md @@ -81,14 +81,14 @@ Prow 명령 | 역할 제한 | 설명 :------------|:------------------|:----------- `/lgtm` | 조직 멤버 | PR 리뷰를 마치고 변경 사항에 만족했음을 나타낸다. `/approve` | 승인자 | PR을 병합(merge)하기 위해 승인한다. -`/assign` | 리뷰어 또는 승인자 | PR을 리뷰하거나 승인할 사람을 지정한다. -`/close` | 리뷰어 또는 승인자 | 이슈 또는 PR을 닫는다. +`/assign` | 누구나 | PR을 리뷰하거나 승인할 사람을 지정한다. +`/close` | 조직 멤버 | 이슈 또는 PR을 닫는다. `/hold` | 누구나 | 자동으로 병합할 수 없음을 나타내는 `do-not-merge/hold` 레이블을 추가한다. `/hold cancel` | 누구나 | `do-not-merge/hold` 레이블을 제거한다. {{< /table >}} -PR에서 사용할 수 있는 명령의 전체 목록을 보려면 -[Prow 명령 레퍼런스](https://prow.k8s.io/command-help)를 참고한다. +PR에서 사용할 수 있는 명령어들을 보려면 +[Prow 명령 레퍼런스](https://prow.k8s.io/command-help?repo=kubernetes%2Fwebsite)를 참고한다. ## 이슈 심사와 분류 diff --git a/content/ko/docs/contribute/review/reviewing-prs.md b/content/ko/docs/contribute/review/reviewing-prs.md index dbd08e60ed..58652b72a7 100644 --- a/content/ko/docs/contribute/review/reviewing-prs.md +++ b/content/ko/docs/contribute/review/reviewing-prs.md @@ -105,10 +105,18 @@ class third,fourth white 1. 행에 대한 의견을 작성하고 **Add single comments**(작성할 의견이 하나만 있는 경우) 또는 **Start a review**(작성할 의견이 여러 개인 경우)를 클릭한다. 1. 완료되면, 페이지 상단에서 **Review changes** 를 클릭한다. 여기에서 - 리뷰에 대한 요약을 추가하고(기여자에게 긍정적인 의견을 남겨주기 바란다!), - PR을 승인하거나, 의견을 보내거나 필요에 따라 변경을 요청할 수 있다. 새로운 기여자는 + 리뷰에 대한 요약을 추가한다(기여자에게 긍정적인 의견을 남겨주기 바란다!). 항상 **Comment** 를 선택해야 한다. + - 리뷰를 완료할 때, "Request changes" 버튼을 누르지 않는다. + 만약 몇몇 변경사항들이 반영되기 전에 PR이 병합되는 것을 막고 싶다면, + "/hold" 명령어를 사용한다. + 왜 "/hold"를 사용하는지 언급해줘야 하며, 어떤 경우에 홀드가 제거되는지에 + 대해서 명세해주는 것은 기여자에게 도움이 된다. + + - 리뷰를 완료할 때, "Approve" 버튼을 누르지 않는다. + 대부분의 경우 "/approve" 명령어를 대신 사용한다. + ## 리뷰 체크리스트 리뷰할 때, 다음을 시작점으로 사용한다. @@ -116,6 +124,18 @@ class third,fourth white ### 언어와 문법 - 언어나 문법에 명백한 오류가 있는가? 무언가를 표현하는 더 좋은 방법이 있는가? + - 기여자가 변경한 부분의 언어와 문법에 집중한다. + 기여자가 문서 전체를 갱신하는 것을 목표로 하지 않는 한, + 해당 문서의 모든 이슈들을 해결할 의무는 없다. + - PR이 기존의 문서를 갱신하는 경우, 갱신된 부분을 검토하는데 집중한다. + 변경된 내용이 기술적으로, 그리고 문서적으로 정확한지 + 검토한다. + 기여자가 해결하려는 문제와 직접적으로 관련 있지는 않은 문제들을 발견할 경우, + 개별적인 이슈로써 처리한다 + (그 전에 해당 문제가 이슈화 되어있는지 확인한다). + - 문서의 경로를 _이동_한 PR이 있는지 주의한다. + 기여자가 문서의 이름을 변경하거나 두개 이상의 문서들을 합치는 경우, 우리(쿠버네티스 SIG Docs)는 + 이동된 문서에서 발견할 수 있는 모든 문법이나 철자를 수정하도록 요청하지는 않는다. - 더 간단한 단어로 대체될 수 있는 복잡하거나 오래된 단어가 있는가? - 비 차별적 대안으로 대체될 수 있는 단어, 용어 또는 문구가 있는가? - 단어 선택과 대소문자는 [스타일 가이드](/docs/contribute/style/style-guide/)를 따르는가? @@ -145,5 +165,21 @@ class third,fourth white ### 기타 -오타나 공백과 같은 작은 이슈의 PR인 경우, 코멘트 앞에 `nit:` 를 추가한다. -이를 통해 문서의 저자는 이슈가 긴급하지 않다는 것을 알 수 있다. +- [사소한 내용만을 가지고 기여](https://www.kubernetes.dev/docs/guide/pull-requests/#trivial-edits)하는 것에 주의한다; + 사소한 수정으로 간주할 수 있는 수정 요청을 발견한다면, 해당 정책을 알려주는 것이 바람직하다 + (실질적인 개선 사항이라면 수용 가능함). +- 공백을 수정하는 기여자들로 하여금, + PR의 첫번째 커밋에서 공백을 수정한 뒤 다른 변경 사항들을 추가하도록 권장한다. + 이는 검토와 병합 과정을 더욱 쉽게 한다. + 특히 대량으로 공백을 정리하는 하나의 커밋에서 발생하는 사소한 변경사항들에 주의한다. + (만약 이를 확인한 경우, 기여자에게 수정을 권장하도록 한다.) + +리뷰어로써, PR에서 공백 문제나 오타 등 크게 중요하지 않은 사소한 이슈들을 발견하는 경우, +리뷰 앞에 `nit:`을 붙인다. +이렇게 함으로써 기여자가 해당 피드백이 크게 중요하지 않다는 것을 알 수 있다. + +nit으로 표시된 피드백을 제외하고 모든 이슈들을 해결한 PR은 병합할 수 있다. +이러한 경우, 아직 해결되지 않는 nit 사항들에 대하여 새롭게 이슈를 여는 것을 권장한다. +또한 새로운 이슈를 [Good First Issue](https://www.kubernetes.dev/docs/guide/help-wanted/#good-first-issue)]로써 +표시할 수 있는지에 대해 고려해본다. +가능한 경우, 이것은 새로운 기여자에게 좋은 소스가 된다. diff --git a/content/ko/docs/contribute/style/write-new-topic.md b/content/ko/docs/contribute/style/write-new-topic.md index 21529e0ce8..ec955111db 100644 --- a/content/ko/docs/contribute/style/write-new-topic.md +++ b/content/ko/docs/contribute/style/write-new-topic.md @@ -1,7 +1,7 @@ --- title: 새로운 주제의 문서 작성 content_type: task -weight: 20 +weight: 70 --- @@ -100,7 +100,7 @@ YAML 블록이다. 여기 예시가 있다. - `kubectl get deploy mydeployment -o json | jq '.status'`와 같은 명령어의 출력을 보여주는 코드. - 시도해보기에는 적절하지 않은 코드. 예를 들어 - 특정 [FlexVolume](/ko/docs/concepts/storage/volumes#flexvolume) 구현에 따라 + 특정 [FlexVolume](/ko/docs/concepts/storage/volumes#flexvolume-deprecated) 구현에 따라 파드를 만들기 위해 YAML 파일을 포함할 수 있다. - 더 큰 파일의 일부분을 강조하기 위한 불완전한 예제 코드. diff --git a/content/ko/docs/reference/_index.md b/content/ko/docs/reference/_index.md index 0ced9fc52f..3eb5b1fd7a 100644 --- a/content/ko/docs/reference/_index.md +++ b/content/ko/docs/reference/_index.md @@ -82,8 +82,9 @@ TCP/UDP 스트림 포워딩이나 백-엔드 집합에 걸쳐서 라운드-로 [kubelet 환경설정 (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/) * [kubelet 자격증명 제공자 (v1alpha1)](/docs/reference/config-api/kubelet-credentialprovider.v1alpha1/) * [kubelet 자격증명 제공자 (v1beta1)](/docs/reference/config-api/kubelet-credentialprovider.v1beta1/) -* [kube-scheduler 환경설정 (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/) 및 - [kube-scheduler 환경설정 (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) +* [kube-scheduler 환경설정 (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/), + [kube-scheduler 환경설정 (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) and + [kube-scheduler 환경설정 (v1)](/docs/reference/config-api/kube-scheduler-config.v1/) * [kube-proxy 환경설정 (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/) * [`audit.k8s.io/v1` API](/docs/reference/config-api/apiserver-audit.v1/) * [클라이언트 인증 API (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/) 및 diff --git a/content/ko/docs/reference/access-authn-authz/_index.md b/content/ko/docs/reference/access-authn-authz/_index.md index fc2faebbb6..c58a72fecb 100644 --- a/content/ko/docs/reference/access-authn-authz/_index.md +++ b/content/ko/docs/reference/access-authn-authz/_index.md @@ -1,6 +1,6 @@ --- title: API 접근 제어 -weight: 15 +weight: 30 no_list: true --- diff --git a/content/ko/docs/reference/access-authn-authz/kubelet-authn-authz.md b/content/ko/docs/reference/access-authn-authz/kubelet-authn-authz.md index 2ce711f69d..6cbf766cb3 100644 --- a/content/ko/docs/reference/access-authn-authz/kubelet-authn-authz.md +++ b/content/ko/docs/reference/access-authn-authz/kubelet-authn-authz.md @@ -2,6 +2,7 @@ # reviewers: # - liggitt title: Kubelet 인증/인가 +weight: 110 ---