You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/zh-cn/docs/contribute/new-content/blogs-case-studies.md
+97-48Lines changed: 97 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,9 +26,10 @@ Case studies require extensive review before they're approved.
26
26
<!--
27
27
## The Kubernetes Blog
28
28
29
-
The Kubernetes blog is used by the project to communicate new features, community reports, and any news that might be relevant to the Kubernetes community.
30
-
This includes end users and developers.
31
-
Most of the blog's content is about things happening in the core project, but we encourage you to submit about things happening elsewhere in the ecosystem too!
29
+
The Kubernetes blog is used by the project to communicate new features, community reports, and any
30
+
news that might be relevant to the Kubernetes community. This includes end users and developers.
31
+
Most of the blog's content is about things happening in the core project, but we encourage you to
32
+
submit about things happening elsewhere in the ecosystem too!
32
33
33
34
Anyone can write a blog post and submit it for review.
34
35
-->
@@ -45,8 +46,8 @@ Kubernetes 博客用于项目发布新功能特性、
45
46
<!--
46
47
### Submit a Post
47
48
48
-
Blog posts should not be commercial in nature and should consist of original content that applies broadly to the Kubernetes community.
49
-
Appropriate blog content includes:
49
+
Blog posts should not be commercial in nature and should consist of original content that applies
50
+
broadly to the Kubernetes community. Appropriate blog content includes:
50
51
51
52
- New Kubernetes capabilities
52
53
- Kubernetes projects updates
@@ -76,7 +77,6 @@ Unsuitable content includes:
76
77
- Partner updates without an integration and customer story
77
78
- Syndicated posts (language translations ok)
78
79
-->
79
-
80
80
不合适的博客内容包括:
81
81
82
82
- 供应商产品推介
@@ -86,12 +86,17 @@ Unsuitable content includes:
86
86
<!--
87
87
To submit a blog post, follow these steps:
88
88
89
-
1. [Sign the CLA](https://kubernetes.io/docs/contribute/start/#sign-the-cla) if you have not yet done so.
90
-
1. Have a look at the Markdown format for existing blog posts in the [website repository](https://github.com/kubernetes/website/tree/master/content/en/blog/_posts).
89
+
1. [Sign the CLA](https://github.com/kubernetes/community/blob/master/CLA.md)
90
+
if you have not yet done so.
91
+
1. Have a look at the Markdown format for existing blog posts in the
1. Write out your blog post in a text editor of your choice.
92
-
1. On the same link from step 2, click the Create new file button. Paste your content into the editor. Name the file to match the proposed title of the blog post, but don’t put the date in the file name. The blog reviewers will work with you on the final file name and the date the blog will be published.
94
+
1. On the same link from step 2, click the Create new file button. Paste your content into the editor.
95
+
Name the file to match the proposed title of the blog post, but don’t put the date in the file name.
96
+
The blog reviewers will work with you on the final file name and the date the blog will be published.
93
97
1. When you save the file, GitHub will walk you through the pull request process.
94
-
1. A blog post reviewer will review your submission and work with you on feedback and final details. When the blog post is approved, the blog will be scheduled for publication.
98
+
1. A blog post reviewer will review your submission and work with you on feedback and final details.
99
+
When the blog post is approved, the blog will be scheduled for publication.
95
100
-->
96
101
要提交博文,你可以遵从以下步骤:
97
102
@@ -110,9 +115,16 @@ To submit a blog post, follow these steps:
110
115
### Guidelines and expectations
111
116
112
117
- Blog posts should not be vendor pitches.
113
-
- Articles must contain content that applies broadly to the Kubernetes community. For example, a submission should focus on upstream Kubernetes as opposed to vendor-specific configurations. Check the [Documentation style guide](/docs/contribute/style/content-guide/#what-s-allowed) for what is typically allowed on Kubernetes properties.
114
-
- Links should primarily be to the official Kubernetes documentation. When using external references, links should be diverse - For example a submission shouldn't contain only links back to a single company's blog.
115
-
- Sometimes this is a delicate balance. The [blog team](https://kubernetes.slack.com/messages/sig-docs-blog/) is there to give guidance on whether a post is appropriate for the Kubernetes blog, so don't hesitate to reach out.
118
+
- Articles must contain content that applies broadly to the Kubernetes community. For example, a
119
+
submission should focus on upstream Kubernetes as opposed to vendor-specific configurations.
120
+
Check the [Documentation style guide](/docs/contribute/style/content-guide/#what-s-allowed) for
121
+
what is typically allowed on Kubernetes properties.
122
+
- Links should primarily be to the official Kubernetes documentation. When using external
123
+
references, links should be diverse - For example a submission shouldn't contain only links
124
+
back to a single company's blog.
125
+
- Sometimes this is a delicate balance. The [blog team](https://kubernetes.slack.com/messages/sig-docs-blog/)
126
+
is there to give guidance on whether a post is appropriate for the Kubernetes blog, so don't
127
+
hesitate to reach out.
116
128
-->
117
129
### 指导原则和期望 {#guidelines-and-expectations}
118
130
@@ -130,9 +142,12 @@ To submit a blog post, follow these steps:
130
142
所以,需要帮助的时候不要犹豫。
131
143
<!--
132
144
- Blog posts are not published on specific dates.
133
-
- Articles are reviewed by community volunteers. We'll try our best to accommodate specific timing, but we make no guarantees.
134
-
- Many core parts of the Kubernetes projects submit blog posts during release windows, delaying publication times. Consider submitting during a quieter period of the release cycle.
135
-
- If you are looking for greater coordination on post release dates, coordinating with [CNCF marketing](https://www.cncf.io/about/contact/) is a more appropriate choice than submitting a blog post.
145
+
- Articles are reviewed by community volunteers. We'll try our best to accommodate specific
146
+
timing, but we make no guarantees.
147
+
- Many core parts of the Kubernetes projects submit blog posts during release windows, delaying
148
+
publication times. Consider submitting during a quieter period of the release cycle.
149
+
- If you are looking for greater coordination on post release dates, coordinating with
150
+
[CNCF marketing](https://www.cncf.io/about/contact/) is a more appropriate choice than submitting a blog post.
136
151
- Sometimes reviews can get backed up. If you feel your review isn't getting the attention it needs,
137
152
you can reach out to the blog team on the [`#sig-docs-blog` Slack channel](https://kubernetes.slack.com/messages/sig-docs-blog/)
138
153
to ask in real time.
@@ -150,19 +165,24 @@ To submit a blog post, follow these steps:
150
165
151
166
<!--
152
167
- Blog posts should be relevant to Kubernetes users.
168
+
153
169
- Topics related to participation in or results of Kubernetes SIGs activities are always on
154
-
topic (see the work in the [Upstream Marketing Team](https://github.com/kubernetes/community/blob/master/communication/marketing-team/storytelling-resources/blog-guidelines.md#upstream-marketing-blog-guidelines)
170
+
topic (see the work in the [Contributor Comms Team](https://github.com/kubernetes/community/blob/master/communication/contributor-comms/storytelling-resources/blog-guidelines.md#upstream-marketing-blog-guidelines)
155
171
for support on these posts).
156
-
- The components of Kubernetes are purposely modular, so tools that use existing integration points like CNI and CSI are on topic.
157
-
- Posts about other CNCF projects may or may not be on topic. We recommend asking the blog team before submitting a draft.
158
-
- Many CNCF projects have their own blog. These are often a better choice for posts. There are times of major feature or milestone for a CNCF project that users would be interested in reading on the Kubernetes blog.
159
-
- Blog posts about contributing to the Kubernetes project should be in the [Kubernetes Contributors site](https://kubernetes.dev)
172
+
- The components of Kubernetes are purposely modular, so tools that use existing integration
173
+
points like CNI and CSI are on topic.
174
+
- Posts about other CNCF projects may or may not be on topic. We recommend asking the blog team
175
+
before submitting a draft.
176
+
- Many CNCF projects have their own blog. These are often a better choice for posts. There are
177
+
times of major feature or milestone for a CNCF project that users would be interested in
178
+
reading on the Kubernetes blog.
179
+
- Blog posts about contributing to the Kubernetes project should be in the
@@ -172,9 +192,11 @@ To submit a blog post, follow these steps:
172
192
<!--
173
193
- Blog posts should be original content
174
194
- The official blog is not for repurposing existing content from a third party as new content.
175
-
- The [license](https://github.com/kubernetes/website/blob/main/LICENSE) for the blog allows commercial use of the content for commercial purposes, just not the other way around.
195
+
- The [license](https://github.com/kubernetes/website/blob/main/LICENSE) for the blog allows
196
+
commercial use of the content for commercial purposes, but not the other way around.
176
197
- Blog posts should aim to be future proof
177
-
- Given the development velocity of the project, we want evergreen content that won't require updates to stay accurate for the reader.
198
+
- Given the development velocity of the project, we want evergreen content that won't require
199
+
updates to stay accurate for the reader.
178
200
- It can be a better choice to add a tutorial or update official documentation than to write a
179
201
high level overview as a blog post.
180
202
- Consider concentrating the long technical content as a call to action of the blog post, and
@@ -187,15 +209,19 @@ To submit a blog post, follow these steps:
187
209
- 博客文章的内容应该在一段时间内不过期。
188
210
- 考虑到项目的开发速度,我们希望读者看到的是不必更新就能保持长期准确的内容。
189
211
- 有时候,在官方文档中添加一个教程或者进行内容更新都是比博客更好的选择。
190
-
- 可以考虑在博客文章中将较长技术内容的重点放在鼓励读者自行尝试上,或者
191
-
放在问题域本身或者为什么读者应该关注某个话题上。
212
+
- 可以考虑在博客文章中将较长技术内容的重点放在鼓励读者自行尝试上,
213
+
或者放在问题域本身或者为什么读者应该关注某个话题上。
192
214
193
215
<!--
194
216
### Technical Considerations for submitting a blog post
195
217
196
-
Submissions need to be in Markdown format to be used by the [Hugo](https://gohugo.io/) generator for the blog. There are [many resources available](https://gohugo.io/documentation/) on how to use this technology stack.
218
+
Submissions need to be in Markdown format to be used by the [Hugo](https://gohugo.io/) generator
219
+
for the blog. There are [many resources available](https://gohugo.io/documentation/) on how to use
220
+
this technology stack.
197
221
198
-
We recognize that this requirement makes the process more difficult for less-familiar folks to submit, and we're constantly looking at solutions to lower this bar. If you have ideas on how to lower the barrier, please volunteer to help out.
222
+
We recognize that this requirement makes the process more difficult for less-familiar folks to
223
+
submit, and we're constantly looking at solutions to lower this bar. If you have ideas on how to
@@ -207,22 +233,30 @@ We recognize that this requirement makes the process more difficult for less-fam
207
233
如果你有降低难度的好主意,请自荐帮忙。
208
234
209
235
<!--
210
-
The SIG Docs [blog subproject](https://github.com/kubernetes/community/tree/master/sig-docs/blog-subproject) manages the review process for blog posts. For more information, see [Submit a post](https://github.com/kubernetes/community/tree/master/sig-docs/blog-subproject#submit-a-post).
236
+
The SIG Docs [blog subproject](https://github.com/kubernetes/community/tree/master/sig-docs/blog-subproject)
237
+
manages the review process for blog posts. For more information, see
238
+
[Submit a post](https://github.com/kubernetes/community/tree/master/sig-docs/blog-subproject#submit-a-post).
211
239
212
240
To submit a blog post follow these directions:
213
241
-->
214
-
SIG Docs [博客子项目](https://github.com/kubernetes/community/tree/master/sig-docs/blog-subproject) 负责管理博客的评阅过程。
- [Open a pull request](/docs/contribute/new-content/open-a-pr/#fork-the-repo) with a new blog post. New blog posts go under the [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/main/content/en/blog/_posts) directory.
249
+
- [Open a pull request](/docs/contribute/new-content/open-a-pr/#fork-the-repo) with a new blog post.
250
+
New blog posts go under the [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/main/content/en/blog/_posts)
251
+
directory.
221
252
222
-
- Ensure that your blog post follows the correct naming conventions and the following frontmatter (metadata) information:
253
+
- Ensure that your blog post follows the correct naming conventions and the following frontmatter
254
+
(metadata) information:
223
255
224
-
- The Markdown file name must follow the format `YYYY-MM-DD-Your-Title-Here.md`. For example, `2020-02-07-Deploying-External-OpenStack-Cloud-Provider-With-Kubeadm.md`.
225
-
- Do **not** include dots in the filename. A name like `2020-01-01-whats-new-in-1.19.md` causes failures during a build.
256
+
- The Markdown file name must follow the format `YYYY-MM-DD-Your-Title-Here.md`. For example,
@@ -244,18 +278,25 @@ SIG Docs [博客子项目](https://github.com/kubernetes/community/tree/master/s
244
278
slug: text-for-URL-link-here-no-spaces
245
279
---
246
280
```
247
-
<!--
248
-
- The first or initial commit message should be a short summary of the work being done and should stand alone as a description of the blog post. Please note that subsequent edits to your blog will be squashed into this main commit, so it should be as useful as possible.
281
+
282
+
<!--
283
+
- The first or initial commit message should be a short summary of the work being done and
284
+
should stand alone as a description of the blog post. Please note that subsequent edits to
285
+
your blog will be squashed into this main commit, so it should be as useful as possible.
286
+
249
287
- Examples of a good commit message:
250
-
- _Add blog post on the foo kubernetes feature_
251
-
- _blog: foobar announcement_
288
+
- _Add blog post on the foo kubernetes feature_
289
+
- _blog: foobar announcement_
252
290
- Examples of bad commit message:
253
291
- _Add blog post_
254
292
- _._
255
293
- _initial commit_
256
294
- _draft post_
257
-
- The blog team will then review your PR and give you comments on things you might need to fix. After that the bot will merge your PR and your blog post will be published.
258
-
-->
295
+
296
+
- The blog team will then review your PR and give you comments on things you might need to fix.
297
+
After that the bot will merge your PR and your blog post will be published.
298
+
-->
299
+
259
300
- 第一个或者最初的提交的描述信息中应该包含一个所作工作的简单摘要,
260
301
并作为整个博文的一个独立描述。
261
302
请注意,对博文的后续修改编辑都会最终合并到此主提交中,所以此提交的描述信息
@@ -271,8 +312,14 @@ SIG Docs [博客子项目](https://github.com/kubernetes/community/tree/master/s
271
312
- 博客团队会对 PR 内容进行评阅,为你提供一些评语以便修订。
272
313
之后,机器人会将你的博文合并并发表。
273
314
274
-
<!--
275
-
- If the content of the blog post contains only content that is not expected to require updates to stay accurate for the reader, it can be marked as evergreen and exempted from the automatic warning about outdated content added to blog posts older than one year.
315
+
<!--
316
+
- The blog team will then review your PR and give you comments on things you might need to fix.
317
+
After that the bot will merge your PR and your blog post will be published.
318
+
319
+
- If the content of the blog post contains only content that is not expected to require updates
320
+
to stay accurate for the reader, it can be marked as evergreen and exempted from the automatic
321
+
warning about outdated content added to blog posts older than one year.
322
+
276
323
- To mark a blog post as evergreen, add this to the front matter:
277
324
278
325
```yaml
@@ -281,7 +328,7 @@ SIG Docs [博客子项目](https://github.com/kubernetes/community/tree/master/s
281
328
- Examples of content that should not be marked evergreen:
282
329
- **Tutorials** that only apply to specific releases or versions and not all future versions
283
330
- References to pre-GA APIs or features
284
-
-->
331
+
-->
285
332
286
333
- 如果博文的内容仅包含预期无需更新就能对读者保持精准的内容,
287
334
则可以将这篇博文标记为长期有效(evergreen),
@@ -299,13 +346,15 @@ SIG Docs [博客子项目](https://github.com/kubernetes/community/tree/master/s
299
346
<!--
300
347
## Submit a case study
301
348
302
-
Case studies highlight how organizations are using Kubernetes to solve
303
-
real-world problems. The Kubernetes marketing team and members of the {{< glossary_tooltip text="CNCF" term_id="cncf" >}} collaborate with you on all case studies.
349
+
Case studies highlight how organizations are using Kubernetes to solve real-world problems. The
350
+
Kubernetes marketing team and members of the {{< glossary_tooltip text="CNCF" term_id="cncf" >}}
351
+
collaborate with you on all case studies.
304
352
305
353
Have a look at the source for the
306
354
[existing case studies](https://github.com/kubernetes/website/tree/main/content/en/case-studies).
307
355
308
-
Refer to the [case study guidelines](https://github.com/cncf/foundation/blob/master/case-study-guidelines.md) and submit your request as outlined in the guidelines.
356
+
Refer to the [case study guidelines](https://github.com/cncf/foundation/blob/master/case-study-guidelines.md)
357
+
and submit your request as outlined in the guidelines.
0 commit comments