@@ -37,18 +37,18 @@ git 워크플로에 익숙하지 않은 경우, 풀 리퀘스트를
3737
3838{{< mermaid >}}
3939flowchart LR
40- A([ fa: fa-user 신규<br >기여자] ) --- id1[ (K8s/Website <br >GitHub)]
40+ A([ fa: fa-user 신규<br >기여자] ) --- id1[ (kubernetes/website <br >GitHub)]
4141subgraph tasks[ GitHub 상에서 변경하기]
4242direction TB
4343 0[ ] -.-
44- 1[ 1. '페이지 편집' 누르기 ] --> 2[ 2. GitHub 마크다운<br >편집기로 편집하기 ]
45- 2 --> 3[ 3. 'Propose file change'에< br >추가 내용 기재하기 ]
44+ 1[ 1. '페이지 편집' 클릭 ] --> 2[ 2. GitHub 마크다운<br >에디터로 내용 변경 ]
45+ 2 --> 3[ 3. 'Commit changes...' 클릭 ]
4646
4747end
4848subgraph tasks2[ ]
4949direction TB
50- 4[ 4. 'Propose changes' 누르기 ] --> 5[ 5. 'Create pull request' 누르기 ] --> 6[ 6. 'Open a pull request'에<br >추가 내용 기재하기 ]
51- 6 --> 7[ 7. 'Create pull request' 누르기 ]
50+ 4[ 4. 'Propose changes' 클릭 ] --> 5[ 5. 'Create pull request' 클릭 ] --> 6[ 6. 'Open a pull request'에<br >추가 내용 기재 ]
51+ 6 --> 7[ 7. 'Create pull request' 클릭 ]
5252end
5353
5454id1 --> tasks --> tasks2
@@ -69,7 +69,7 @@ class id1 k8s
6969
70701 . GitHub 마크다운 에디터에서 내용을 수정한다.
7171
72- 1 . 에디터 아래쪽의 ** Propose file change ** 양식을 작성한다 .
72+ 1 . 에디터 오른쪽 상단에서 ** Commit changes ** 를 선택한다 .
7373 첫 번째 필드에는, 커밋 메시지 제목을 지정한다.
7474 두 번째 필드에는, 설명을 제공한다.
7575
@@ -84,9 +84,9 @@ class id1 k8s
8484
85851 . ** Open a pull request** 화면이 나타나면 양식을 작성한다.
8686
87- - 풀 리퀘스트의 ** Subject ** 필드는 기본적으로 커밋 내용을 요약하여 작성한다.
87+ - 풀 리퀘스트의 ** Add a title ** 필드는 기본적으로 커밋 내용을 요약하여 작성한다.
8888 이는 필요한 경우 변경할 수 있다.
89- - ** Body ** 에는 작성할 확장 커밋 메시지가 있다면, 그것을 포함하고,
89+ - ** Add a description ** 에는 작성할 확장 커밋 메시지가 있다면, 그것을 포함하고,
9090 일부 템플릿 텍스트도 포함한다. 템플릿 텍스트에서
9191 요구하는 세부 정보를 추가한 다음, 남은 템플릿 텍스트는 삭제한다.
9292 - ** Allow edits from maintainers** 체크박스는 선택된 상태로 둔다.
@@ -96,19 +96,19 @@ class id1 k8s
9696 자세한 내용은 [ PR 열기] ( #open-a-pr ) 를 참고한다.
9797 {{</ note >}}
9898
99- 1 . ** Create pull request** 를 선택한다.
99+ 1 . ** Create pull request** 를 선택한다.
100100
101101### GitHub에서 피드백 반영하기
102102
103103풀 리퀘스트가 병합되기 전에, 쿠버네티스 커뮤니티 멤버가 이를 리뷰하고
104- 승인한다. ` k8s-ci-robot ` 해당 페이지에 언급된 가장 가까운
104+ 승인한다. ` k8s-ci-robot ` 은 해당 페이지에 언급된 가장 가까운
105105오너(owner)를 기준으로 리뷰어를 제안한다. 특정한 사람을 염두에 두고 있다면,
106106GitHub 사용자 이름을 코멘트로 남긴다.
107107
108- 리뷰어가 변경을 요청하는 경우, 다음과 같이 한다.
108+ 리뷰어가 변경을 요청하는 경우:
109109
110- 1 . ** Files changed** 탭으로 이동 한다 .
111- 1 . 풀 리퀘스트에 의해 변경된 파일에서 연필(편집) 아이콘을 선택한다.
110+ 1 . ** Files changed** 탭으로 이동한다 .
111+ 1 . 풀 리퀘스트에 의해 변경된 파일에서 연필 (편집) 아이콘을 선택한다.
1121121 . 요청된 변경에 대한 수정을 한다.
1131131 . 변경 사항을 커밋한다.
114114
@@ -132,16 +132,16 @@ git에 익숙하거나, 변경 사항이 몇 줄보다 클 경우,
132132
133133{{< mermaid >}}
134134flowchart LR
135- 1[ K8s /website<br >저장소 포크하기 ] --> 2[ 로컬 클론 생성<br >및 upstream 설정]
135+ 1[ kubernetes /website<br >리포지터리 포크 ] --> 2[ 로컬 클론 생성<br >및 upstream 설정]
136136subgraph changes[ 당신의 변경사항]
137137direction TB
138138S[ ] -.-
139- 3[ 브랜치 생성<br >예: my_new_branch] --> 3a[ 텍스트 편집기로 <br >변경사항 만들기 ] --> 4[ "Hugo (localhost:1313)<br >를 이용하거나<br >컨테이너 이미지를 빌드하여<br >변경사항을 로컬에서 미리보기"]
139+ 3[ 브랜치 생성<br >예: my_new_branch] --> 3a[ 텍스트 에디터로 <br >변경사항 기재 ] --> 4[ "Hugo (localhost:1313)<br >를 이용하거나<br >컨테이너 이미지를 빌드하여<br >변경사항 로컬에서 미리보기"]
140140end
141141subgraph changes2[ 커밋 / 푸시]
142142direction TB
143143T[ ] -.-
144- 5[ 변경사항 커밋하기 ] --> 6[ 커밋을<br >origin/my_new_branch<br >로 푸시하기 ]
144+ 5[ 변경사항 커밋 ] --> 6[ 커밋을<br >origin/my_new_branch<br >로 푸시 ]
145145end
146146
1471472 --> changes --> changes2
@@ -160,9 +160,9 @@ class changes,changes2 white
160160### kubernetes/website 리포지터리 포크하기
161161
1621621 . [ ` kubernetes/website ` ] ( https://github.com/kubernetes/website/ ) 리포지터리로 이동한다.
163- 1 . ** Fork** 를 선택한다.
163+ 1 . ** Fork** 를 선택한다.
164164
165- ### 로컬 클론 생성 및 업스트림 설정
165+ ### 로컬 클론 생성 및 upstream 설정
166166
1671671 . 터미널 창에서, 포크를 클론하고 [ Docsy Hugo 테마] ( https://github.com/google/docsy#readme ) 를 업데이트한다.
168168
@@ -201,7 +201,7 @@ class changes,changes2 white
201201 git fetch upstream
202202 ```
203203
204- 이를 통해 변경을 시작하기 전에 로컬 리포지터리가 최신 상태인지 확인한다.
204+ 이를 통해 변경 작업을 시작하기 전에 로컬 리포지터리가 최신 상태인지 확인한다.
205205
206206 {{< note >}}
207207 이 워크플로는
@@ -221,7 +221,7 @@ class changes,changes2 white
221221 - 다가오는 쿠버네티스 릴리스의 새로운 기능에 대해서는 기능 브랜치(feature branch)를 사용한다. 자세한 정보는
222222 [ 릴리스 문서화] ( /ko/docs/contribute/new-content/new-features/ ) 를 참고한다.
223223 - 콘텐츠 재구성과 같이 여러 SIG Docs 기여자들이 협업하는 장기적인 작업에는,
224- 해당 작업을 위해 작성된 특정 기능 브랜치를 사용한다.
224+ 해당 작업을 위해 생성된 특정 기능 브랜치를 사용한다.
225225
226226 브랜치 선택에 도움이 필요하면, 슬랙 채널 ` #sig-docs ` 에 문의한다.
227227
@@ -232,7 +232,7 @@ class changes,changes2 white
232232 git checkout -b < my_new_branch> upstream/main
233233 ```
234234
235- 1 . 텍스트 편집기를 사용하여 변경한다.
235+ 1 . 텍스트 에디터를 사용하여 변경한다.
236236
237237언제든지, ` git status ` 명령을 사용하여 변경한 파일을 볼 수 있다.
238238
@@ -292,7 +292,7 @@ class changes,changes2 white
292292푸시하거나 풀 리퀘스트를 열기 전에 변경 사항을 로컬에서 미리 보는 것이 좋다.
293293미리보기를 사용하면 빌드 오류나 마크다운 형식 문제를 알아낼 수 있다.
294294
295- website의 컨테이너 이미지를 만들거나 Hugo를 로컬에서 실행할 수 있다.
295+ website의 컨테이너 이미지를 빌드하거나 Hugo를 로컬에서 실행할 수 있다.
296296도커 이미지 빌드는 느리지만 [ Hugo 단축코드] ( /docs/contribute/style/hugo-shortcodes/ ) 를 표시하므로,
297297디버깅에 유용할 수 있다.
298298
@@ -326,8 +326,8 @@ website의 컨테이너 이미지를 만들거나 Hugo를 로컬에서 실행할
326326 make container-serve
327327 ```
328328
329- 1 . 웹 브라우저에서 ` http://localhost:1313 ` 로 이동한다. Hugo는
330- 변경 사항을 보고 필요에 따라 사이트를 다시 구축한다 .
329+ 1 . 웹 브라우저에서 ` http://localhost:1313 ` 으로 이동한다. Hugo는
330+ 변경 사항을 보고 필요에 따라 사이트를 다시 빌드한다 .
331331
3323321 . 로컬의 Hugo 인스턴스를 중지하려면, 터미널로 돌아가서 ` Ctrl+C ` 를 입력하거나,
333333 터미널 창을 닫는다.
@@ -346,7 +346,7 @@ website의 컨테이너 이미지를 만들거나 Hugo를 로컬에서 실행할
346346 npm ci
347347 ```
348348
349- 1 . 터미널에서, 쿠버네티스 웹사이트 리퍼지토리로 이동한 뒤 Hugo 서버를 실행한다.
349+ 1 . 터미널에서, 쿠버네티스 website 리퍼지토리로 이동한 뒤 Hugo 서버를 실행한다.
350350
351351 ``` shell
352352 cd < path_to_your_repo> /website
@@ -359,19 +359,19 @@ website의 컨테이너 이미지를 만들거나 Hugo를 로컬에서 실행할
359359 ```
360360
3613611 . 웹 브라우저에서 ` http://localhost:1313 ` 으로 이동한다. Hugo는
362- 변경 사항을 보고 필요에 따라 사이트를 다시 구축한다 .
362+ 변경 사항을 보고 필요에 따라 사이트를 다시 빌드한다 .
363363
3643641 . 로컬의 Hugo 인스턴스를 중지하려면, 터미널로 돌아가서 ` Ctrl+C ` 를 입력하거나,
365365 터미널 창을 닫는다.
366366
367367{{% /tab %}}
368368{{< /tabs >}}
369369
370- ### 포크한 저장소에서 kubernetes/website로 풀 리퀘스트 열기 {#open-a-pr}
370+ ### 포크한 리포지터리에서 kubernetes/website로 풀 리퀘스트 열기 {#open-a-pr}
371371
372- 그림 3은 포크한 저장소에서 [ kubernetes/website] ( https://github.com/kubernetes/website ) 로 PR을 여는 단계를 보여 준다. 세부 단계는 아래와 같다.
372+ 그림 3은 포크에서 [ kubernetes/website] ( https://github.com/kubernetes/website ) 로 PR을 여는 단계를 보여 준다. 세부 단계는 아래와 같다.
373373
374- 참고로, 기여자들은` kubernetes/website ` 를 ` k/website ` 로 언급할 수 있다.
374+ 참고로, 기여자들은 ` kubernetes/website ` 를 ` k/website ` 로 언급할 수 있다.
375375
376376<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
377377<!-- You can also cut/paste the mermaid code into the live editor at https://mermaid-js.github.io/mermaid-live-editor to play around with it -->
@@ -380,8 +380,8 @@ website의 컨테이너 이미지를 만들거나 Hugo를 로컬에서 실행할
380380flowchart LR
381381subgraph first[ ]
382382direction TB
383- 1[ 1. K8s /website 저장소로 이동] --> 2[ 2. 'New Pull Request' 클릭]
384- 2 --> 3[ 3. 'Compare across forks' 클릭]
383+ 1[ 1. kubernetes /website 리포지터리로 이동] --> 2[ 2. 'New Pull Request' 클릭]
384+ 2 --> 3[ 3. 'compare across forks' 클릭]
3853853 --> 4[ 4. 'head repository' 드롭다운 메뉴에서<br >당신의 포크 선택]
386386end
387387subgraph second [ ]
@@ -399,42 +399,42 @@ class 1,2,3,4,5,6,7,8 grey
399399class first,second white
400400{{</ mermaid >}}
401401
402- 그림 3. 포크한 저장소에서 [ kubernetes/website] ( https://github.com/kubernetes/website ) 로 PR을 여는 단계.
402+ 그림 3. 포크한 리포지터리에서 [ kubernetes/website] ( https://github.com/kubernetes/website ) 로 PR을 여는 단계.
403403
4044041 . 웹 브라우저에서 [ ` kubernetes/website ` ] ( https://github.com/kubernetes/website/ ) 리포지터리로 이동한다.
405- 1 . ** New Pull Request** 를 선택한다.
406- 1 . ** compare across forks** 를 선택한다.
405+ 1 . ** New Pull Request** 를 선택한다.
406+ 1 . ** compare across forks** 를 선택한다.
4074071 . ** head repository** 드롭다운 메뉴에서, 포크를 선택한다.
4084081 . ** compare** 드롭다운 메뉴에서, 브랜치를 선택한다.
409- 1 . ** Create Pull Request** 를 선택한다.
409+ 1 . ** Create Pull Request** 를 선택한다.
4104101 . 풀 리퀘스트에 대한 설명을 추가한다.
411411
412412 - ** Title** (50자 이하): 변경 사항에 대한 의도를 요약한다.
413413 - ** Description** : 변경 사항을 자세히 설명한다.
414414
415415 - 관련된 GitHub 이슈가 있는 경우, ` Fixes #12345 ` 또는 ` Closes #12345 ` 를
416416 설명에 포함한다. 이렇게 하면 GitHub의 자동화 기능이 PR을 병합한 후 언급된 이슈를 닫는다.
417- 다른 관련된 PR이 있는 경우, 이들 PR도 연결한다 .
417+ 다른 관련된 PR이 있는 경우, 해당 링크도 함께 추가한다 .
418418 - 구체적인 내용에 대한 조언이 필요한 경우, 원하는 질문을 리뷰어가
419419 생각해볼 수 있도록 설명에 포함한다.
420420
4214211 . ** Create pull request** 버튼을 선택한다.
422422
423- 축하한다! 여러분의 풀 리퀘스트가 [ 풀 리퀘스트] ( https://github.com/kubernetes/website/pulls ) 에 등록되었다.
423+ 축하한다! 당신의 풀 리퀘스트가 [ 풀 리퀘스트] ( https://github.com/kubernetes/website/pulls ) 에 등록되었다.
424424
425425PR을 연 후, GitHub는 자동화된 테스트를 실행하고
426426[ Netlify] ( https://www.netlify.com/ ) 를 사용하여 미리보기를 배포하려고 시도한다.
427427
428- - Netlify 빌드가 실패하면, 자세한 정보를 위해 ** Details** 를 선택한다.
429- - Netlify 빌드가 성공하면, ** Details** 를 선택하면 변경 사항이 적용된 쿠버네티스 website의 커밋하기
428+ - Netlify 빌드가 실패하면, 자세한 정보를 위해 ** Details** 를 선택한다.
429+ - Netlify 빌드가 성공하면, ** Details** 를 선택하면 변경 사항이 적용된 쿠버네티스 website의 커밋하기
430430 직전의 버전(staged version)이 열린다. 이는 리뷰어가 변경 사항을 확인하는 방법이다.
431431
432432또한 GitHub는 리뷰어에게 도움을 주기 위해 PR에 레이블을 자동으로 할당한다. 필요한 경우 직접 추가할 수도 있다.
433433자세한 내용은 [ 이슈 레이블 추가와 제거] ( /ko/docs/contribute/review/for-approvers/#이슈-레이블-추가와-제거 ) 를 참고한다.
434434
435435### 로컬에서 피드백 해결하기
436436
437- 1 . 변경한 후, 이전 커밋을 수정한다.
437+ 1 . 변경을 완료한 후, 이전 커밋을 수정한다.
438438
439439 ``` shell
440440 git commit -a --amend
@@ -445,7 +445,7 @@ PR을 연 후, GitHub는 자동화된 테스트를 실행하고
445445
4464461 . 필요한 경우 커밋 메시지를 업데이트한다.
447447
448- 1 . ` git push origin <my_new_branch> ` 를 사용해서 변경 사항을 푸시하고 Netlify 테스트를 다시 실행한다.
448+ 1 . ` git push origin <my_new_branch> ` 를 사용해서 변경 사항을 푸시하고 Netlify 테스트를 다시 실행한다.
449449
450450 {{< note >}}
451451 수정하는 대신 ` git commit -m ` 을 사용하는 경우, 병합하기 전에 [ 커밋을 스쿼시] ( #커밋-스쿼시하기 ) 해야
@@ -454,7 +454,7 @@ PR을 연 후, GitHub는 자동화된 테스트를 실행하고
454454
455455#### 리뷰어의 변경
456456
457- 때때로 리뷰어가 당신의 풀 리퀘스트에 직접 커밋하기도 하기 한다. 따라서 다른 변경을 하기 전에, 먼저 커밋 내역을 가져오자.
457+ 때때로 리뷰어가 당신의 풀 리퀘스트에 직접 커밋하기도 한다. 따라서 다른 변경을 적용하기 전에, 해당 커밋 내역을 가져오자.
458458
4594591 . 원격 포크에서 커밋을 가져오고 작업 브랜치를 리베이스한다.
460460
@@ -493,7 +493,7 @@ PR의 모든 병합 충돌을 해결해야 한다.
493493 git push --force-with-lease origin < your-branch-name>
494494 ```
495495
496- 1 . ` kubernetes/website ` 의 ` upstream/main ` 에 대한 변경 사항을 가져오고 브랜치를 리베이스한다.
496+ 1 . ` kubernetes/website ` 의 ` upstream/main ` 에 대한 변경 사항을 가져오고 브랜치를 리베이스한다.
497497
498498 ``` shell
499499 git fetch upstream
@@ -506,9 +506,9 @@ PR의 모든 병합 충돌을 해결해야 한다.
506506 git status
507507 ```
508508
509- 이 명령의 결과에 여러 파일이 충돌된 것으로 표시된다.
509+ 이 명령의 결과에 여러 파일이 충돌된 것으로 표시된다.
510510
511- 1 . 충돌한 각 파일을 열고 충돌 마커(` >>> ` ,` <<< ` 그리고 ` === ` )를 찾는다.
511+ 1 . 각 충돌 파일을 열고 충돌 마커(` >>> ` ,` <<< ` 그리고 ` === ` )를 찾는다.
512512 충돌을 해결하고 충돌 마커를 삭제한다.
513513
514514 {{< note >}}
@@ -547,11 +547,11 @@ PR의 모든 병합 충돌을 해결해야 한다.
547547{{< /note >}}
548548
549549PR에 여러 커밋이 있는 경우, PR을 병합하기 전에 해당 커밋을 단일 커밋으로 스쿼시해야 한다.
550- PR의 ** Commits** 탭에서 또는 ` git log ` 명령을 로컬에서 실행하여
550+ PR의 ** Commits** 탭에서 또는 로컬에서 ` git log ` 명령을 실행하여
551551커밋 수를 확인할 수 있다.
552552
553553{{< note >}}
554- 여기서는 ` vim ` 을 커맨드 라인 텍스트 편집기로 사용하는 것을 가정한다.
554+ 여기서는 ` vim ` 을 커맨드 라인 텍스트 에디터로 사용하는 것을 가정한다.
555555{{< /note >}}
556556
5575571 . 대화식 리베이스를 시작한다.
@@ -581,7 +581,7 @@ PR의 **Commits** 탭에서 또는 `git log` 명령을 로컬에서 실행하여
581581 각 커밋에 대한 옵션이 나열되어 있다. `pick` 단어를 바꾸면 리베이스가 완료되었을 때
582582 커밋 상태가 변경된다.
583583
584- 리베이스를 하는 목적인 `squash` 와 `pick` 에 집중한다.
584+ 리베이스에서는 `squash` 와 `pick` 에 집중한다.
585585
586586 {{< note >}}
587587 자세한 내용은 [대화식 모드](https://git-scm.com/docs/git-rebase#_interactive_mode)를 참고한다.
@@ -605,7 +605,7 @@ PR의 **Commits** 탭에서 또는 `git log` 명령을 로컬에서 실행하여
605605 squash 7d54e15ee Address feedback 2
606606 ```
607607
608- 이것은 커밋 ` 4fa167b80 Address feedback 1 ` 과 ` 7d54e15ee Address feedback 2 ` 를 ` d875112ca Original commit ` 으로 스쿼시한다.
608+ 이것은 커밋 ` 4fa167b80 Address feedback 1 ` 과 ` 7d54e15ee Address feedback 2 ` 를 ` d875112ca Original commit ` 으로 스쿼시하며,
609609 타임라인의 일부로 ` d875112ca Original commit ` 만 남긴다.
610610
6116111 . 파일을 저장하고 종료한다.
@@ -622,13 +622,13 @@ PR의 **Commits** 탭에서 또는 `git log` 명령을 로컬에서 실행하여
622622리포지터리에는 사용자용 도움말 텍스트, 오류 메시지, API 레퍼런스 또는 코드 주석과
623623같은 문서가 포함되어 있다.
624624
625- 개선하려는 텍스트가 보이면, GitHub을 사용하여 쿠버네티스 조직의 모든
625+ 개선하고 싶은 텍스트가 보이면, GitHub을 사용하여 쿠버네티스 조직의 모든
626626리포지터리를 검색한다. 이를 통해 어디에 이슈나 PR을 제출할지를 파악할 수 있다.
627627
628628각 리포지터리에는 고유한 프로세스와 절차가 있다. 이슈를 등록하거나 PR을 제출하기 전에,
629629해당 리포지터리에 ` README.md ` , ` CONTRIBUTING.md ` 그리고 ` code-of-conduct.md ` 파일이 있다면 읽어본다.
630630
631- 대부분의 리포지터리에는 이슈와 PR 템플릿을 사용한다. 팀의 프로세스를 파악하기 위해
631+ 대부분의 리포지터리에는 이슈와 PR 템플릿을 사용한다. 해당 팀의 프로세스를 파악하기 위해
632632공개된 이슈와 PR을 살펴보자. 이슈나 PR을 제출할 때는
633633가능한 한 상세하게 템플릿의 내용을 작성한다.
634634
0 commit comments