Git Product home page Git Product logo

kubernetes-docs-zh's Introduction

Instructions for Contributing to the Kubernetes Documentation

Welcome! We are very pleased you want to contribute to the Kubernetes documentation.

翻译组工作流程 中文版

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 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:

Building the site using Docker

If you'd like, you can build the Kubernetes docs using Docker. To get started, build the image locally:

make docker-image

# The underlying command:
docker build . \
  --tag kubernetes-hugo \
  --build-arg HUGO_VERSION=0.40.3

You can create an image for a different version of Hugo by changing the value of the HUGO_VERSION argument for the build. You must specify a version or the image will not build. Once the kubernetes-hugo image has been built locally, you can build the site:

make docker-serve

# The underlying command:
docker run \
  --rm \
  --interactive \
  --tty \
  --volume $(PWD):/src \
  -p 1313:1313 \
  kubernetes-hugo \
  hugo server \
  --watch \
  --bind 0.0.0.0

As when building without using a Docker container, the results of the build will be published to the public directory (the default output directory for Hugo, the static site generator used to build this site).

Thank you!

Kubernetes thrives on community participation, and we really appreciate your contributions to our site and our documentation!

kubernetes-docs-zh's People

Contributors

adamdang avatar andrewmichaelsmith avatar bjdzliu avatar chenopis avatar chenrui333 avatar chentao11596 avatar chrismarino avatar congfairy avatar janetkuo avatar jiaj12 avatar johndmulhausen avatar k8s-ci-robot avatar keithtt avatar lichuqiang avatar madhusudancs avatar mr-linus avatar niuhp avatar okzhchy avatar pigletfly avatar pwittrock avatar rata avatar rootsongjc avatar rutsky avatar thockin avatar tianshapjq avatar xiaosuiba avatar yangy2000 avatar yinshuxun avatar yulng avatar zhangqx2010 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

kubernetes-docs-zh's Issues

Translating all files under /docs/user-guide/kubectl

Umbrella issue of all kubectl commands translation.

  • kubectl
  • kubectl annotate
  • kubectl api-versions
  • kubectl apply
  • kubectl attach
  • kubectl autoscale
  • kubectl cluster-info
  • kubectl config
  • kubectl create
  • kubectl delete
  • kubectl describe
  • kubectl edit
  • kubectl exec
  • kubectl expose
  • kubectl get
  • kubectl label
  • kubectl logs
  • kubectl namespace
  • kubectl patch
  • kubectl port-forward
  • kubectl proxy
  • kubectl replace
  • kubectl rolling-update
  • kubectl run
  • kubectl scale
  • kubectl stop
  • kubectl version

how to track original docs update

it is really a big help to come up with such a repo.

I just want to know what if the original docs updates, what's the way to let us be aware and do the corresponding updates.

Create a SECURITY_CONTACTS file.

As per the email sent to kubernetes-dev[1], please create a SECURITY_CONTACTS
file.

The template for the file can be found in the kubernetes-template repository[2].
A description for the file is in the steering-committee docs[3], you might need
to search that page for "Security Contacts".

Please feel free to ping me on the PR when you make it, otherwise I will see when
you close this issue. :)

Thanks so much, let me know if you have any questions.

(This issue was generated from a tool, apologies for any weirdness.)

[1] https://groups.google.com/forum/#!topic/kubernetes-dev/codeiIoQ6QE
[2] https://github.com/kubernetes/kubernetes-template-project/blob/master/SECURITY_CONTACTS
[3] https://github.com/kubernetes/community/blob/master/committee-steering/governance/sig-governance-template-short.md

ideas about prioritizing the articles needed to translate

As far, we need to prioritize the articles left to speed up the translation. Here are the principles we had agreement until now:

  1. Add a new column including P0-PN in the index table to identify the priorities: P0s are the most urgent tasks, PN can scale from 1-4 (just my opinion). [Owner: TBD]
  2. Ignore the auto-generated files at present. Should list all the files. [Owner: TBD]
  3. Ignore the articles indicating feature has been deprecated. Should list all the files. [Owner: TBD]

Any suggestions are welcomed!

@hanjiayao @chentao1596 @linyouchong @zhangxiaoyu-zidif @xiangpengzhao @zhouhaibing089 @lichuqiang @markthink

Translating some files under user guide

This is the list i've been working on:

  • docs/user-guide/index.md
  • docs/user-guide/annotations.md
  • docs/user-guide/labels.md
  • docs/user-guide/namespaces.md
  • docs/user-guide/identifiers.md
  • docs/user-guide/pods.md
  • docs/user-guide/replication-controller.md
  • docs/user-guide/service.md
  • docs/user-guide/volumes.md
  • docs/user-guide/secrets.md

The items checked are translated already, once i've finished the list above I will send a pull request by the end of the week soon.

Some ideas about the contribution on docs-cn repo

  1. We need a clear standard for the condition under which a PR could get merged,say a certain number of guys have reviewed and approved.
  2. Commit records might need to be squashed before PR get merged, as we do in k8s repo.
  3. We may need to add a list to the CI-robot, which includes the guys who are active in the field of translation. Thus, a new PR could be assigned to one of the guys in the list for review automatically or manually.

Please feel free to give your opinions:)

Kubernetes 中英文词汇标准对应表

Kubernetes 中英文词汇标准对应表

Kubernetes 中英文词汇标准对应表 的完善分两步走:

第一阶段:在12月31日之前,定一个基础版本的中英文词汇对照表。

先由 @李晶晶-H3C-成都 @宋净超-jimmysong.io @石龙-HandReach-青岛 @时延军-希为科技-北京 @李储强-华为-杭州 @苏楚霖-IBM-深圳 @陈涛-ZTE-三亚 @张琦翔-geniusafc-上海 @邢舟-IBM 一起完善一下中英词汇的标准化,有不同的意见,可以在此留言,默认大家提交的初始化版本,都是采纳状态。

第二阶段:在12月31日之后,新词汇的加入方式

元旦之后,新增的词汇,默认都是未采纳状态,每个新增词汇需通过讨论确定最优的翻译结果。

注:初始词汇的翻译邀请是以前期贡献的顺序排名的..当然未邀请的译者,有兴趣也是可以参与一起完善初始版本的中英文词汇表的,此表并未记名。

我们希望能够保持一份精减,大家容易有岐义的词汇对照表,尽可能给新加入的译者不会造成过多的困惑。

这里会每周同步 Google 词汇表格的更新记录:

kubernetes master node => kubernetes master节点
kubernetes worker node => kubernetes worker节点
load balancer => 负载均衡器
API Server => API 服务器
load balance => 负载均衡
runtime => runtime
cloud provider =>云服务提供商
dns entry => dns 条目
control plane => 控制平面

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.