Welcome! This repository houses all of the assets required to build the Kubernetes website and documentation. We're very pleased that you want to contribute!
You can click the Fork button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a fork. Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it.
Once your pull request is created, a Kubernetes reviewer will take responsibility for providing clear, actionable feedback. As the owner of the pull request, it is your responsibility to modify your pull request to address the feedback that has been provided to you by the Kubernetes reviewer. Also note that you may end up having more than one Kubernetes reviewer provide you feedback or you may end up getting feedback from a Kubernetes reviewer that is different than the one originally assigned to provide you feedback. Furthermore, in some cases, one of your reviewers might ask for a technical review from a Kubernetes tech reviewer when needed. Reviewers will do their best to provide feedback in a timely fashion but response time can vary based on circumstances.
For more information about contributing to the Kubernetes documentation, see:
- Start contributing
- Staging Your Documentation Changes
- Using Page Templates
- Documentation Style Guide
- Localizing Kubernetes Documentation
The recommended way to run the Kubernetes website locally is to run a specialized Docker image that includes the Hugo static site generator.
If you are running on Windows, you'll need a few more tools which you can install with Chocolatey.
choco install make
If you'd prefer to run the website locally without Docker, see Running the site locally using Hugo below.
If you have Docker up and running, build the kubernetes-hugo Docker image locally:
make docker-imageOnce the image has been built, you can run the site locally:
make docker-serveOpen up your browser to http://localhost:1313 to view the site. As you make changes to the source files, Hugo updates the site and forces a browser refresh.
See the official Hugo documentation for Hugo installation instructions. Make sure to install the Hugo version specified by the HUGO_VERSION environment variable in the netlify.toml file.
To run the site locally when you have Hugo installed:
make serveThis will start the local Hugo server on port 1313. Open up your browser to http://localhost:1313 to view the site. As you make changes to the source files, Hugo updates the site and forces a browser refresh.
2018-08-28 회의 및 현재까지 진행된 PR, Issue 과정을 바탕으로 작성하였습니다.
현재 open 되어 있는 issue 중 번역하고자 하는 페이지 관련 issue를 assign 받으신 후 진행이 필요합니다. 거버넌스 상 쿠버네티스 멤버에게만 assign이 가능하기 때문에 현재는 해당 issue에 comment를 추가하는 과정으로 진행하고 있습니다.
만약 해당 페이지의 issue가 오픈 되어 있지 않다면 여기에서 생성해주시면 됩니다.
kubernetes/website 프로젝트를 개인 계정으로 fork 합니다.
이 과정이 잘 이해가 되지 않으신다면
git fork관련 내용을 검색해보시면 됩니다.
fork한 repository의 content/ko/docs 위치에 기존 존재하는 원본 파일을 원문을 최대한 살려서 번역합니다.
단, dev-1.13-ko.1 기준, 아래 용어집을 바탕으로 번역이 필요합니다.
- (1순위) 한글화팀 용어집
- (2순위) 기타 참고 용어집 : Symantec 용어집 | Microsoft 언어 포털 | OpenStack 한글 번역팀 단어집
또한, dev-1.13-ko.1 브랜치와의 충돌을 막기 위해 새로운 브랜치를 생성해서 작업하시는 것을 추천드립니다.
이 과정이 잘 이해가 되지 않으신다면
git branch관련 내용을 검색해보시면 됩니다.
Docker로 문서 빌드하는 방법 | k8s/website README.md를 참고하여 수정된 작업의 내용이 정상적으로 빌드가 되는지 확인합니다.
fork한 repository의 내용을 kubernetes/website repository ko translation branch 에 PR(Pull Request)를 생성합니다.
이 과정이 잘 이해되지 않는다면
git pull request관련 내용을 검색해보시면 됩니다.
PR(Pull Request) 리뷰의 경우 해당 PR의 File changed 탭에서 라인 번호 옆 +버튼을 누르신 후 진행하시면 됩니다.
이외 궁금한 사항은 kubernetes Slack에 kubernetes-docs-ko Slack 채널에 문의 부탁드립니다. kubernetes Slack 가입은 slack.k8s.io 을 통해서 하실 수 있습니다.
Kubernetes thrives on community participation, and we really appreciate your contributions to our site and our documentation!
이외 추가 사항이나 수정할 사항에 대해서는 Comment 남겨주시면 수정하겠습니다.
CLA 내용 적용 필요성?: 삭제