|
1 | 1 | ---
|
2 |
| -title: 贡献新内容 |
3 |
| -weight: 20 |
| 2 | +content_type: concept |
| 3 | +title: 贡献 Kubernetes 文档 |
| 4 | +linktitle: 贡献 |
| 5 | +main_menu: true |
| 6 | +no_list: true |
| 7 | +weight: 80 |
| 8 | +card: |
| 9 | + name: 贡献 |
| 10 | + weight: 10 |
| 11 | + title: 开始贡献 |
4 | 12 | ---
|
| 13 | +<!-- |
| 14 | +--- |
| 15 | +content_type: concept |
| 16 | +title: Contribute to Kubernetes docs |
| 17 | +linktitle: Contribute |
| 18 | +main_menu: true |
| 19 | +no_list: true |
| 20 | +weight: 80 |
| 21 | +card: |
| 22 | + name: contribute |
| 23 | + weight: 10 |
| 24 | + title: Start contributing |
| 25 | +--- |
| 26 | +--> |
| 27 | + |
| 28 | +<!-- overview --> |
5 | 29 |
|
6 | 30 | <!--
|
7 |
| -title: Contributing new content |
8 |
| -weight: 20 |
| 31 | +This website is maintained by [Kubernetes SIG Docs](/docs/contribute/#get-involved-with-sig-docs). |
| 32 | +
|
| 33 | +Kubernetes documentation contributors: |
| 34 | +
|
| 35 | +- Improve existing content |
| 36 | +- Create new content |
| 37 | +- Translate the documentation |
| 38 | +- Manage and publish the documentation parts of the Kubernetes release cycle |
| 39 | +
|
| 40 | +Kubernetes documentation welcomes improvements from all contributors, new and experienced! |
| 41 | +--> |
| 42 | + |
| 43 | +本网站由 [Kubernetes SIG(特别兴趣小组) Docs](/zh/docs/contribute/#参与docs特别兴趣小组) 维护. |
| 44 | + |
| 45 | +Kubernetes 文档项目的贡献者: |
| 46 | + |
| 47 | +- 改进现有内容 |
| 48 | +- 创建新内容 |
| 49 | +- 翻译文档 |
| 50 | +- 管理并发布 Kubernetes 周期性发行版的文档 |
| 51 | + |
| 52 | +Kubernetes 文档欢迎来自各方贡献者的改进,无论新手还是高手! |
| 53 | + |
| 54 | +<!-- body --> |
| 55 | + |
| 56 | +<!-- |
| 57 | +## Getting started |
| 58 | +
|
| 59 | +Anyone can open an issue about documentation, or contribute a change with a |
| 60 | +pull request (PR) to the |
| 61 | +[`kubernetes/website` GitHub repository](https://github.com/kubernetes/website). |
| 62 | +You need to be comfortable with |
| 63 | +[git](https://git-scm.com/) and |
| 64 | +[GitHub](https://lab.github.com/) |
| 65 | +to work effectively in the Kubernetes community. |
| 66 | +
|
| 67 | +To get involved with documentation: |
| 68 | +
|
| 69 | +1. Sign the CNCF [Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md). |
| 70 | +1. Familiarize yourself with the [documentation repository](https://github.com/kubernetes/website) |
| 71 | + and the website's [static site generator](https://gohugo.io). |
| 72 | +1. Make sure you understand the basic processes for |
| 73 | + [opening a pull request](/docs/contribute/new-content/open-a-pr/) and |
| 74 | + [reviewing changes](/docs/contribute/review/reviewing-prs/). |
| 75 | +
|
| 76 | +Some tasks require more trust and more access in the Kubernetes organization. |
| 77 | +See [Participating in SIG Docs](/docs/contribute/participate/) for more details about |
| 78 | +roles and permissions. |
9 | 79 | -->
|
| 80 | +## 入门 |
| 81 | + |
| 82 | +任何人都可以提出文档方面的问题(issue),或贡献一个变更,用拉取请求(PR)的方式提交到 |
| 83 | +[GitHub 上的 `kubernetes/website` 仓库](https://github.com/kubernetes/website)。 |
| 84 | +当然你需要熟练使用 [git](https://git-scm.com/) 和 [GitHub](https://lab.github.com/) 才能在 Kubernetes 社区中有效工作。 |
| 85 | + |
| 86 | +参与文档编制: |
| 87 | + |
| 88 | +1. 签署 CNCF 的[贡献者许可协议](https://github.com/kubernetes/community/blob/master/CLA.md)。 |
| 89 | +2. 熟悉[文档仓库](https://github.com/kubernetes/website) |
| 90 | + 和网站的[静态站点生成器](https://gohugo.io)。 |
| 91 | +3. 确保理解 |
| 92 | + [发起拉取请求 (PR)](/zh/docs/contribute/new-content/open-a-pr/) 和 |
| 93 | + [审查变更](/zh/docs/contribute/review/reviewing-prs/) 的基本流程。 |
| 94 | + |
| 95 | +有些任务要求 Kubernetes 组织内更高的信任级别和访问权限。 |
| 96 | +阅读[参与 SIG Docs 工作](/zh/docs/contribute/participate/) ,获取角色和权限的更多细节。 |
| 97 | + |
| 98 | +<!-- |
| 99 | +## Your first contribution |
| 100 | +
|
| 101 | +- Read the [Contribution overview](/docs/contribute/new-content/overview/) to |
| 102 | + learn about the different ways you can contribute. |
| 103 | +- Check [`kubernetes/website` issues list](https://github.com/kubernetes/website/issues/) |
| 104 | + for issues that make good entry points. |
| 105 | +- [Open a pull request using GitHub](/docs/contribute/new-content/open-a-pr/#changes-using-github) |
| 106 | + to existing documentation and learn more about filing issues in GitHub. |
| 107 | +- [Review pull requests](/docs/contribute/review/reviewing-prs/) from other |
| 108 | + Kubernetes community members for accuracy and language. |
| 109 | +- Read the Kubernetes [content](/docs/contribute/style/content-guide/) and |
| 110 | + [style guides](/docs/contribute/style/style-guide/) so you can leave informed comments. |
| 111 | +- Learn about [page content types](/docs/contribute/style/page-content-types/) |
| 112 | + and [Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/). |
| 113 | +--> |
| 114 | +## 第一次贡献 |
| 115 | + |
| 116 | +- 通读[贡献概述](/zh/docs/contribute/new-content/overview/),了解参与贡献的不同方式。 |
| 117 | +- 查看[`kubernetes/website` 问题列表](https://github.com/kubernetes/website/issues/) |
| 118 | + ,检索最适合作为切入点的问题。 |
| 119 | +- 在现有文档上, |
| 120 | + [使用 GitHub 提交变更 (PR)](/zh/docs/contribute/new-content/open-a-pr/#changes-using-github), |
| 121 | + 掌握在 GitHub 上登记 Issue 的方法。 |
| 122 | +- Kubernetes 社区其他成员会[评审拉取请求 (PR)](/zh/docs/contribute/review/reviewing-prs/), |
| 123 | + 以确保文档精准和语言流畅。 |
| 124 | +- 阅读 kubernetes 的[内容指南](/zh/docs/contribute/style/content-guide/)和 |
| 125 | + [风格指南](/docs/contribute/style/style-guide/) ,以发表有见地的评论。 |
| 126 | +- 了解[页面内容类型](/zh/docs/contribute/style/page-content-types/)和 |
| 127 | + [Hugo 短代码](/zh/docs/contribute/style/hugo-shortcodes/)。 |
| 128 | + |
| 129 | +<!-- |
| 130 | +## Next steps |
| 131 | +
|
| 132 | +- Learn to [work from a local clone](/docs/contribute/new-content/open-a-pr/#fork-the-repo) |
| 133 | + of the repository. |
| 134 | +- Document [features in a release](/docs/contribute/new-content/new-features/). |
| 135 | +- Participate in [SIG Docs](/docs/contribute/participate/), and become a |
| 136 | + [member or reviewer](/docs/contribute/participate/roles-and-responsibilities/). |
| 137 | + |
| 138 | +- Start or help with a [localization](/docs/contribute/localization/). |
| 139 | +--> |
| 140 | +## 下一步 |
| 141 | + |
| 142 | +- 学习在仓库的[本地克隆中工作](/zh/docs/contribute/new-content/open-a-pr/#fork-the-repo)。 |
| 143 | +- 为[发行版的特性](/zh/docs/contribute/new-content/new-features/)编写文档。 |
| 144 | +- 加入 [SIG Docs](/zh/docs/contribute/participate/), 并成为[成员或评审者](/zh/docs/contribute/participate/roles-and-responsibilities/)。 |
| 145 | + |
| 146 | +- 开始或帮助[本地化](/zh/docs/contribute/localization/) 工作。 |
| 147 | + |
| 148 | +<!-- |
| 149 | +## Get involved with SIG Docs |
| 150 | +
|
| 151 | +[SIG Docs](/docs/contribute/participate/) is the group of contributors who |
| 152 | +publish and maintain Kubernetes documentation and the website. Getting |
| 153 | +involved with SIG Docs is a great way for Kubernetes contributors (feature |
| 154 | +development or otherwise) to have a large impact on the Kubernetes project. |
| 155 | +
|
| 156 | +SIG Docs communicates with different methods: |
| 157 | +
|
| 158 | +- [Join `#sig-docs` on the Kubernetes Slack instance](https://slack.k8s.io/). Make sure to |
| 159 | + introduce yourself! |
| 160 | +- [Join the `kubernetes-sig-docs` mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs), |
| 161 | + where broader discussions take place and official decisions are recorded. |
| 162 | +- Join the [weekly SIG Docs video meeting](https://github.com/kubernetes/community/tree/master/sig-docs). Meetings are always announced on `#sig-docs` and added to the [Kubernetes community meetings calendar](https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com&ctz=America/Los_Angeles). You'll need to download the [Zoom client](https://zoom.us/download) or dial in using a phone. |
| 163 | +--> |
| 164 | +## 参与 SIG Docs 工作 |
| 165 | + |
| 166 | +[SIG Docs](/zh/docs/contribute/participate/) 是负责发布、维护 Kubernetes 文档的贡献者团体。 |
| 167 | +参与 SIG Docs 是 Kubernetes 贡献者(开发者和其他人员)对 Kubernetes 项目产生重大影响力的好方式。 |
| 168 | + |
| 169 | +SIG Docs 的几种沟通方式: |
| 170 | + |
| 171 | +- [加入 Kubernetes 在 Slack 上的`#sig-docs` 频道](https://slack.k8s.io/)。 |
| 172 | + 一定记得自我介绍! |
| 173 | +- [加入`kubernetes-sig-docs` 邮件列表](https://groups.google.com/forum/#!forum/kubernetes-sig-docs), |
| 174 | + 这里有更广泛的讨论,和官方决策的记录。 |
| 175 | +- 参加 [SIG Docs 的每周视频会议](https://github.com/kubernetes/community/tree/master/sig-docs)。会议总是在 `#sig-docs` 上宣告,同时添加到 |
| 176 | + [Kubernetes社区会议日历](https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com&ctz=America/Los_Angeles)。 |
| 177 | + 你需要下载 [Zoom 客户端软件](https://zoom.us/download),或电话拨号接入。 |
| 178 | + |
| 179 | +<!-- |
| 180 | +## Other ways to contribute |
| 181 | +
|
| 182 | +- Visit the [Kubernetes community site](/community/). Participate on Twitter or Stack Overflow, learn about local Kubernetes meetups and events, and more. |
| 183 | +- Read the [contributor cheatsheet](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet) to get involved with Kubernetes feature development. |
| 184 | +- Submit a [blog post or case study](/docs/contribute/new-content/blogs-case-studies/). |
| 185 | +--> |
| 186 | +## 其他贡献方式 |
| 187 | + |
| 188 | +- 访问 [Kubernetes 社区网站](/zh/community/)。 参与 Twitter 或 Stack Overflow, 了解 Kubernetes 当地的聚会和活动, 等等。 |
| 189 | +- 阅读[贡献者备忘单](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet) ,参与 Kubernetes 功能开发。 |
| 190 | +- 提交一篇[博客文章或案例研究](/zh/docs/contribute/new-content/blogs-case-studies/)。 |
0 commit comments