Skip to content

Commit edb7ed9

Browse files
authored
Merge pull request #50425 from windsonsea/newcon
[zh] Add new-content/case-studies.md and update _index.md
2 parents 9fbcefd + 4853106 commit edb7ed9

File tree

2 files changed

+79
-27
lines changed

2 files changed

+79
-27
lines changed

content/zh-cn/docs/contribute/new-content/_index.md

Lines changed: 34 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,37 @@
22
title: 贡献新内容
33
content_type: 概念
44
main_menu: true
5-
weight: 20
5+
weight: 25
6+
simple_list: true # 针对 whatsnext 一节
67
---
78
<!--
89
title: Contributing new content
910
content_type: concept
1011
main_menu: true
11-
weight: 20
12+
weight: 25
13+
simple_list: true # for whatsnext section
1214
-->
1315

1416
<!-- overview -->
1517

1618
<!--
1719
This section contains information you should know before contributing new
18-
content.
19-
-->
20+
content.
2021
22+
There are also dedicated pages about submitting [case studies](/docs/contribute/new-content/case-studies)
23+
and [blog articles](/docs/contribute/blog/).
24+
-->
2125
本节包含你在贡献新内容之前需要知晓的信息。
2226

27+
另请参阅如何提交[案例分析](/zh-cn/docs/contribute/new-content/case-studies)[博客文章](/zh-cn/docs/contribute/blog/)的专门页面。
28+
29+
<!-- body -->
30+
31+
<!--
32+
## New content task flow
33+
-->
34+
## 新内容的任务流程 {#new-content-task-flow}
35+
2336
<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
2437
<!-- 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 -->
2538

@@ -58,8 +71,7 @@ class first,second white
5871
The figure above depicts the information you should know
5972
prior to submitting new content. The information details follow.
6073
-->
61-
62-
***插图 - 贡献新内容准备工作***
74+
**插图 - 贡献新内容准备工作**
6375

6476
上图描述了你在提交新内容之前需要知晓的信息。
6577
详细信息见下文。
@@ -77,9 +89,8 @@ prior to submitting new content. The information details follow.
7789
the `update-imported-docs/` directory.
7890
- [Page content types](/docs/contribute/style/page-content-types/) describe the
7991
presentation of documentation content in Hugo.
80-
-->
81-
82-
## 基本知识
92+
-->
93+
## 基本知识 {#contributing-basics}
8394

8495
- 使用 Markdown 编写 Kubernetes 文档并使用 [Hugo](https://gohugo.io/) 构建网站。
8596
- Kubernetes 文档使用 [CommonMark](https://commonmark.org/) 作为 Markdown 的风格。
@@ -101,7 +112,6 @@ prior to submitting new content. The information details follow.
101112
or starting a new translation,
102113
see [localization](/docs/contribute/localization).
103114
-->
104-
105115
- 你可以使用 [Docsy 短代码](https://www.docsy.dev/docs/adding-content/shortcodes/)
106116
[定制的 Hugo 短代码](/zh-cn/docs/contribute/style/hugo-shortcodes/)贡献 Kubernetes 文档。
107117
- 除了标准的 Hugo 短代码外,
@@ -115,26 +125,28 @@ prior to submitting new content. The information details follow.
115125

116126
<!--
117127
## Before you begin {#before-you-begin}
128+
118129
### Sign the CNCF CLA {#sign-the-cla}
130+
119131
All Kubernetes contributors **must** read
120132
the [Contributor guide](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md)
121133
and [sign the Contributor License Agreement (CLA)](https://github.com/kubernetes/community/blob/master/CLA.md).
134+
122135
Pull requests from contributors who haven't signed the CLA fail the automated
123136
tests. The name and email you provide must match those found in
124137
your `git config`, and your git name and email must match those used for the
125138
CNCF CLA.
126139
-->
140+
## 开始之前 {#before-you-begin}
127141

128-
## 开始之前 {#before-you-begin}
129-
130-
### 签署 CNCF CLA {#sign-the-cla}
142+
### 签署 CNCF CLA {#sign-the-cla}
131143

132144
所有 Kubernetes 贡献者**必须**阅读[贡献者指南](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md)
133145
[签署贡献者授权同意书 (Contributor License Agreement, CLA)](https://github.com/kubernetes/community/blob/master/CLA.md)
134146

135147
若贡献者尚未签署 CLA,其发起的 PR 将无法通过自动化测试。
136148
你所提供的姓名和邮件地址必须与 `git config` 中配置的完全相同,
137-
而且你的 git 用户名和邮件地址必须与用来签署 CNCF CLA 的信息一致。
149+
而且你的 Git 用户名和邮件地址必须与用来签署 CNCF CLA 的信息一致。
138150

139151
<!--
140152
### Choose which Git branch to use
@@ -150,26 +162,23 @@ Content in other languages (localizations) | Use the localization's convention.
150162
151163
If you're still not sure which branch to choose, ask in `#sig-docs` on Slack.
152164
-->
153-
154-
### 选择要使用的 Git 分支
165+
### 选择要使用的 Git 分支 {#choose-which-git-branch-to-use}
155166

156167
在发起 PR 时,你需要预先知道基于哪个分支来开展工作。
157168

158169
场景 | 分支
159170
:---------|:------------
160171
针对当前发行版本的,对现有英文内容的修改或新的英文内容 | `main`
161-
针对功能特性变更的内容 | 分支对应于功能特性变更的主要和次要版本,分支名称采用 `dev-<version>` 的模式。例如,如果某功能特性在 `v{{< skew nextMinorVersion >}}` 版本发生变化,则对应的文档变化要添加到 `dev-{{< skew nextMinorVersion >}}` 分支。
162-
其他语言的内容(本地化) | 基于本地化团队的约定。参见[本地化分支策略](/zh-cn/docs/contribute/localization/#branch-strategy)了解更多信息。
172+
针对功能特性变更的内容 | 分支对应于功能特性变更的主要和次要版本,分支名称采用 `dev-<version>` 的模式。例如,如果某功能特性在 `v{{< skew nextMinorVersion >}}` 版本发生变化,则对应的文档变化要添加到 `dev-{{< skew nextMinorVersion >}}` 分支。
173+
其他语言的内容(本地化) | 基于本地化团队的约定。参见[本地化分支策略](/zh-cn/docs/contribute/localization/#branch-strategy)了解更多信息。
163174

164175
如果你仍不能确定要选择哪个分支,请在 Slack 的 `#sig-docs` 频道上提出问题。
165176

177+
{{< note >}}
166178
<!--
167-
{{< note >}} If you already submitted your pull request and you know that the
168-
base branch was wrong, you (and only you, the submitter) can change it. {{<
169-
/note >}}
179+
If you already submitted your pull request and you know that the
180+
base branch was wrong, you (and only you, the submitter) can change it.
170181
-->
171-
172-
{{< note >}}
173182
如果你已经提交了 PR,并且发现所针对的分支选错了,你(且只有作为提交人的你)可以更改分支。
174183
{{< /note >}}
175184

@@ -180,8 +189,7 @@ Limit pull requests to one language per PR. If you need to make an identical
180189
change to the same code sample in multiple languages, open a separate PR for
181190
each language.
182191
-->
183-
184-
### 每个 PR 牵涉的语言
192+
### 每个 PR 牵涉的语言 {#languages-per-pr}
185193

186194
请确保每个 PR 仅涉及一种语言。
187195
如果你需要对多种语言下的同一代码示例进行相同的修改,也请为每种语言发起一个独立的 PR。
@@ -193,8 +201,7 @@ The [doc contributors tools](https://github.com/kubernetes/website/tree/main/con
193201
directory in the `kubernetes/website` repository contains tools to help your
194202
contribution journey go more smoothly.
195203
-->
196-
197-
## 为贡献者提供的工具
204+
## 为贡献者提供的工具 {#tools-for-contributors}
198205

199206
`kubernetes/website` 仓库的[文档贡献者工具](https://github.com/kubernetes/website/tree/main/content/zh-cn/docs/doc-contributor-tools)目录中包含了一些工具,
200207
有助于使你的贡献过程更为顺畅。
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: 提交案例分析
3+
linktitle: 案例分析
4+
slug: case-studies
5+
content_type: concept
6+
weight: 30
7+
---
8+
<!--
9+
title: Submitting case studies
10+
linktitle: Case studies
11+
slug: case-studies
12+
content_type: concept
13+
weight: 30
14+
-->
15+
16+
<!-- overview -->
17+
18+
<!--
19+
Case studies highlight how organizations are using Kubernetes to solve real-world problems. The
20+
Kubernetes marketing team and members of the {{< glossary_tooltip text="CNCF" term_id="cncf" >}}
21+
collaborate with you on all case studies.
22+
23+
Case studies require extensive review before they're approved.
24+
-->
25+
案例分析用来概述组织如何使用 Kubernetes 解决现实世界的问题。
26+
Kubernetes 市场化团队和 {{< glossary_tooltip text="CNCF" term_id="cncf" >}} 成员会与你一起工作,
27+
撰写所有的案例分析。
28+
29+
案例分析需要经过广泛的评审后,才能被批准合并。
30+
31+
<!-- body -->
32+
33+
<!--
34+
## Submit a case study
35+
36+
Have a look at the source for the
37+
[existing case studies](https://github.com/kubernetes/website/tree/main/content/en/case-studies).
38+
39+
Refer to the [case study guidelines](https://github.com/cncf/foundation/blob/master/case-study-guidelines.md)
40+
and submit your request as outlined in the guidelines.
41+
-->
42+
请查看[现有案例分析](https://github.com/kubernetes/website/tree/main/content/zh-cn/case-studies)的源码。
43+
44+
参考[案例分析指南](https://github.com/cncf/foundation/blob/master/case-study-guidelines.md)
45+
根据指南中的注意事项提交你的 PR 请求。

0 commit comments

Comments
 (0)