Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ko] Reorg 'Windows in K8s' docs #35423

Conversation

jihoon-seo
Copy link
Member

@jihoon-seo jihoon-seo commented Jul 27, 2022

Umbrella issue: #34903

  • D3. content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md

이 영문 파일은 여러 파일로 쪼개졌습니다.

[#31428 참고]

https://kubernetes.io/docs/setup/production-environment/windows/intro-windows-in-kubernetes/

각 영문 PR(#31850, #31851, #34083, #33582)을 참고하여 여러 ko 파일로 쪼갰으며,
한국어 파일 content/ko/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md 이 outdated 된 지 꽤 오래 되어서 (#30364),
쪼개고 난 뒤에 영문 파일과 비교하여 업데이트가 필요한 부분은 업데이트를 하였습니다.

이 PR의 변경사항이 너무 커서 리뷰가 힘든 경우
이 PR에 포함된 총 7 8개의 커밋을 나눠
커밋 1~3개를 포함하는 여러 개의 PR로 나눌 수도 있겠습니다.

아니면 이 PR 내에서 각 커밋별로 리뷰를 하는 방법도 있겠습니다.
(다만 이렇게 하면 GitHub 리뷰 UI의 "Add a suggestion" 기능을 사용할 수 없고,
각 커밋에 추가한 comment가 "Files changed" 페이지에는 표출되지 않을 수도 있으며,
추후 커밋 (hash) 변경 시 리뷰 comment가 유실될 수도 있음)

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 27, 2022
@k8s-ci-robot k8s-ci-robot requested a review from jmyung July 27, 2022 01:45
@k8s-ci-robot k8s-ci-robot added the language/ko Issues or PRs related to Korean language label Jul 27, 2022
@k8s-ci-robot k8s-ci-robot requested a review from yoonian July 27, 2022 01:45
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jul 27, 2022
@netlify
Copy link

netlify bot commented Jul 27, 2022

Deploy Preview for k8s-dev-ko ready!

Name Link
🔨 Latest commit 25a7dfd
🔍 Latest deploy log https://app.netlify.com/sites/k8s-dev-ko/deploys/62edf9382285350008fce12e
😎 Deploy Preview https://deploy-preview-35423--k8s-dev-ko.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@seokho-son
Copy link
Member

지금처럼 1개의 PR로 작업하면 어떨까 싶습니다. :)
아마 커밋도 향후 스쿼싱하는 것이 좋을 것이란 생각입니다. (여러 신규 문서 생성이라기보단, 기존 문서 쪼개기라)

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's some odd whitespace - I'd remove it.

content/ko/docs/concepts/security/windows-security.md Outdated Show resolved Hide resolved
content/ko/docs/concepts/storage/windows-storage.md Outdated Show resolved Hide resolved
content/ko/docs/concepts/windows/intro.md Outdated Show resolved Hide resolved
content/ko/docs/concepts/windows/user-guide.md Outdated Show resolved Hide resolved
content/ko/docs/tasks/debug/debug-cluster/windows.md Outdated Show resolved Hide resolved
@seokho-son
Copy link
Member

There's some odd whitespace - I'd remove it.

Hi @sftim :)
Thank you for the review.
I think those white spaces have been added intentionally.

  • to make structure of lines of a Korean document similar with the source English document
  • and to remove reviewer section

It is beneficial when we update outdated Korean contents :)

@sftim
Copy link
Contributor

sftim commented Jul 27, 2022

A tip, then (for all Korean l10n): rather than whitespace, how about a comment block. For example:

## placeholder comment
## 
## these comments align Korean text line numbers with English original

That would communicate intent more clearly and helps to preserve alignment.

@seokho-son
Copy link
Member

seokho-son commented Jul 27, 2022

@sftim
Thank you for sharing your idea !!
I think it would be a much better way :)

Your idea will be shared and discussed in an upcoming Korean localization team meeting. Thanks.

assuming following example works.

---
## reviewers:
## - jayunit100
## - jsturtevant
## - marosset
## - perithompson
title: Resource Management for Windows nodes
content_type: concept
weight: 75
---

@jihoon-seo jihoon-seo force-pushed the 220722_ko_Reorg_Windows-in-K8s branch from 361e845 to 434d5af Compare July 29, 2022 01:29
@jihoon-seo
Copy link
Member Author

@sftim Thank you for your comments!
In last night's Korean L10n team meeting (@seokho-son is the team lead),
we agreed to keep those lines with being commented, to preserve alignment.
(IMO it is expected that this commenting the original lines would communicate intent implicitly,
and in future we Korean L10n team might notice the updates in upstream files when the reviewers of English files are updated and, in turn, different from the commented lines of Korean files.)

And I used just single # character per line instead of two characters, since

  • single character seems enough,
  • and many editors' (including VS Code) default behavior of toggling commentize is to prepend single # character and single space.

Copy link
Contributor

@yoonian yoonian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jihoon-seo 감사합니다! 👍 분량에서 놀라고 깔끔해서 놀라고 빨라서 더 놀랍니다. 급히(?!) 살펴보았는데, 확인 부탁드려요.

윈도우는 모든 사용자-모드 메모리 할당을 항상 가상 메모리처럼 처리하며, 페이지파일이 필수이다.

윈도우 노드는 프로세스를 위해 메모리를 오버커밋(overcommit)하지 않는다.
이로 인해 윈도우는 메모리 부족(OOM, out of memory) 컨디션에 도달하는 방식이 리눅스와 다르며,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
이로 인해 윈도우는 메모리 부족(OOM, out of memory) 컨디션에 도달하는 방식이 리눅스와 다르며,
이로 인해 윈도우는 메모리 부족(OOM, out of memory) 조건에 도달하는 방식이 리눅스와 다르며,

이렇게 써도 괜찮을 것 같아 보입니다.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[원문]

Windows nodes do not overcommit memory for processes. The
net effect is that Windows won't reach out of memory conditions the same way Linux
does, and processes page to disk instead of being subject to out of memory (OOM)
termination. If memory is over-provisioned and all physical memory is exhausted,
then paging can slow down performance.

'condition' 이 1) 조건, 또는 2) 상태 로 해석될 수 있는데,
쿠버네티스에서는 'node condition' 이라고 하면 '노드의 상태' 를 나타내는 것으로 보이고

conditions 필드는 모든 Running 노드의 상태를 기술한다. 컨디션의 예로 다음을 포함한다.

kubelet은 하드/소프트 축출 임계값 조건이 충족되어 노드 압박이 발생했다는 것을 알리기 위해, 설정된 유예 시간과는 관계없이 노드 컨디션을 보고한다.

kubelet은 다음과 같이 노드 컨디션과 축출 신호를 매핑한다.

이 부분에서도 '윈도우 노드가 OOM 상태에 도달하는 방식' 을 뜻하는 것으로 보여서
'컨디션' 으로 기재하였는데..
위의 사항에 대해서 어떻게 생각하시나요? 😊

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

기존의 제 번역이 원문과 차이가 있어, 다음과 같이 수정했습니다. 😊

이로 인해 윈도우는 메모리 컨디션에 도달하는 방식이 리눅스와 다르며,

content/ko/docs/concepts/security/windows-security.md Outdated Show resolved Hide resolved
content/ko/docs/tasks/debug/debug-cluster/windows.md Outdated Show resolved Hide resolved
Copy link
Member Author

@jihoon-seo jihoon-seo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yoonian 리뷰 감사합니다!!
저도 의견을 몇 개 남겼으며..
적어 주신 나머지 의견도 추후에 한꺼번에 반영하겠습니다. 😊

@bconfiden2
Copy link
Member

리뷰와는 별개로 리뷰어 부분의 주석처리에 대한 질문이 있습니다!

아래의 두가지 방식 중에 저는 sftim 님이 제안주신 위쪽 방식과 같은 느낌이 좋지 않을까 생각했었는데, 아래쪽처럼 영문 문서의 리뷰어를 주석처리하여 남겨놓는 방식으로 진행되는 것 같아서 말씀드려봅니다!! 🤔 🤔

# placeholder comment
#
#
# these comments align Korean text line numbers with English original
title: Resource Management for Windows nodes
content_type: concept
weight: 75
---
# reviewers:
# - jayunit100
# - jsturtevant
# - marosset
title: Resource Management for Windows nodes
content_type: concept
weight: 75
---

현재 스크립트를 통해 한글 문서들에 공백으로 남겨져있던(혹은 아예 리뷰어가 지워져있던) 부분들을 일괄적으로 처리하려고 시도 중입니다! 😃

@jihoon-seo
Copy link
Member Author

@bconfiden2 아 저는 #35423 (comment) 및 아래의 이유로 이 PR에서 이와 같이 처리하였습니다. 😊

IMO it is expected that this commenting the original lines would communicate intent implicitly,
and in future we Korean L10n team might notice the updates in upstream files when the reviewers of English files are updated and, in turn, different from the commented lines of Korean files.

저번 한글화팀 회의의 회의록을 보니 다음과 같이 기록되어 있네요.

리뷰어 항목은 주석 처리하는 것이 좋을 것이라는 것에 동의

두 가지 옵션 중에서 어떤 것으로 할 지 정해지지는 않은 것 같습니다. 😊

필요 시,
(다음 정기 회의는 꽤 남은 것 같아서) K8s Docs 한글화팀 슬랙 채널에서 추가 논의를 해 볼 수도 있을 것 같습니다.. 😊

@bconfiden2
Copy link
Member

@jihoon-seo 리뷰어 항목을 주석 처리하는 것도 좋을 것 같아서, 저도 그대로 진행 하겠습니다~! 😊

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 4, 2022
@k8s-ci-robot k8s-ci-robot requested a review from yoonian August 4, 2022 07:54
@jihoon-seo jihoon-seo force-pushed the 220722_ko_Reorg_Windows-in-K8s branch from 02bd95d to 5c18a8a Compare August 4, 2022 07:57
@jihoon-seo
Copy link
Member Author

@yoonian @seokho-son 감사합니다!
리뷰 의견들을 반영했습니다.
확인 부탁드립니다!

/unhold
(리뷰 의견 반영을 위해 hold를 했었는데, 이러면 관련된 분들에게 노티가 가니까
다음부터는 hold 대신 GitHub의 'draft' 기능을 쓰는 것이 좋을 것 같습니다. 😊)

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 4, 2022
@seokho-son
Copy link
Member

@jihoon-seo 아닙니다.. :)
적절한 시점에 기능을 활용하여, 잘 hold 해주셨습니다.

Copy link
Contributor

@yoonian yoonian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jihoon-seo 좀 더 살펴보았습니다. 😓

@jihoon-seo jihoon-seo force-pushed the 220722_ko_Reorg_Windows-in-K8s branch from 5c18a8a to 6588b8f Compare August 6, 2022 01:27
@jihoon-seo
Copy link
Member Author

@yoonian 감사합니다. 모두 반영하였습니다. 확인 부탁드립니다. 😊

Copy link
Contributor

@yoonian yoonian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jihoon-seo 감사합니다. 다시 살펴보았습니다.

Comment on lines 52 to 53
쿠버네티스 노드로의/노드로부터의 볼륨 연결(attaching)/해제(detaching),
데이터를 보존해야 하는 파드 내 개별 컨테이너로의/컨테이너로부터의 볼륨 마운트/해제와 같은 동작을 포함한다.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
쿠버네티스 노드로의/노드로부터의 볼륨 연결(attaching)/해제(detaching),
데이터를 보존해야 하는 파드 내 개별 컨테이너로의/컨테이너로부터의 볼륨 마운트/해제와 같은 동작을 포함한다.
쿠버네티스 노드로의 볼륨 연결(attaching)과 노드로부터의 해제(detaching),
데이터를 보존해야 하는 파드 내 개별 컨테이너로의 볼륨 마운트와 컨테이너로부터의 해제 같은 동작을 포함한다.

자연스럽게 해 보았습니다.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[원문]

Management of persistent volumes associated with a specific storage back-end or protocol includes actions such as provisioning/de-provisioning/resizing of volumes, attaching/detaching a volume to/from a Kubernetes node and mounting/dismounting a volume to/from individual containers in a pod that needs to persist data.

처음 번역할 때에는 생각하지 못했는데,
주신 의견을 보다 보니,
전치사 ("to/from") 부분을 전부 번역할 필요가 없었던 것 같아서,
좀 더 자연스럽도록

쿠버네티스 노드로의 볼륨 연결(attaching) 및 해제(detaching), 
데이터를 보존해야 하는 파드 내 개별 컨테이너로의 볼륨 마운트 및 해제 같은 동작을 포함한다.

이렇게 반영해 보았습니다 😊

@jihoon-seo
Copy link
Member Author

@yoonian 감사합니다. 추가로 주신 의견을 반영하였습니다. 확인 부탁드립니다. 😊

@yoonian
Copy link
Contributor

yoonian commented Aug 6, 2022

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 6, 2022
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: e674059e142df65fb3a482b14744de94e953f026

@seokho-son
Copy link
Member

@jihoon-seo
감사합니다! 일부 커밋은 스쿼싱하면 좋을 것 같습니다.
다만, 해당 PR은 ko.2 마일스톤에 관련되어 있어서, 필요에 따라 레이블로 스쿼싱 처리를 하도록 하겠습니다. :)

@seokho-son
Copy link
Member

/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Aug 7, 2022
@seokho-son
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: seokho-son

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 7, 2022
@k8s-ci-robot k8s-ci-robot merged commit 47fdff4 into kubernetes:dev-1.24-ko.2 Aug 7, 2022
@jihoon-seo jihoon-seo deleted the 220722_ko_Reorg_Windows-in-K8s branch August 8, 2022 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/ko Issues or PRs related to Korean language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants