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
@@ -16,16 +16,17 @@ Case studies require extensive review before they're approved.
16
16
17
17
## The Kubernetes Blog
18
18
19
-
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.
20
-
This includes end users and developers.
21
-
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!
19
+
The Kubernetes blog is used by the project to communicate new features, community reports, and any
20
+
news that might be relevant to the Kubernetes community. This includes end users and developers.
21
+
Most of the blog's content is about things happening in the core project, but we encourage you to
22
+
submit about things happening elsewhere in the ecosystem too!
22
23
23
24
Anyone can write a blog post and submit it for review.
24
25
25
26
### Submit a Post
26
27
27
-
Blog posts should not be commercial in nature and should consist of original content that applies broadly to the Kubernetes community.
28
-
Appropriate blog content includes:
28
+
Blog posts should not be commercial in nature and should consist of original content that applies
29
+
broadly to the Kubernetes community. Appropriate blog content includes:
29
30
30
31
- New Kubernetes capabilities
31
32
- Kubernetes projects updates
@@ -43,75 +44,138 @@ Unsuitable content includes:
43
44
44
45
To submit a blog post, follow these steps:
45
46
46
-
1.[Sign the CLA](https://kubernetes.io/docs/contribute/start/#sign-the-cla) if you have not yet done so.
47
-
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).
47
+
1.[Sign the CLA](https://github.com/kubernetes/community/blob/master/CLA.md)
48
+
if you have not yet done so.
49
+
50
+
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.
49
-
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.
54
+
55
+
1. On the same link from step 2, click the Create new file button. Paste your content into the editor.
56
+
Name the file to match the proposed title of the blog post, but don’t put the date in the file name.
57
+
The blog reviewers will work with you on the final file name and the date the blog will be published.
58
+
50
59
1. When you save the file, GitHub will walk you through the pull request process.
51
-
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.
60
+
61
+
1. A blog post reviewer will review your submission and work with you on feedback and final details.
62
+
When the blog post is approved, the blog will be scheduled for publication.
52
63
53
64
### Guidelines and expectations
54
65
55
66
- Blog posts should not be vendor pitches.
56
-
- 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.
57
-
- 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.
58
-
- 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.
67
+
68
+
- Articles must contain content that applies broadly to the Kubernetes community. For example, a
69
+
submission should focus on upstream Kubernetes as opposed to vendor-specific configurations.
70
+
Check the [Documentation style guide](/docs/contribute/style/content-guide/#what-s-allowed) for
71
+
what is typically allowed on Kubernetes properties.
72
+
- Links should primarily be to the official Kubernetes documentation. When using external
73
+
references, links should be diverse - For example a submission shouldn't contain only links
74
+
back to a single company's blog.
75
+
- Sometimes this is a delicate balance. The [blog team](https://kubernetes.slack.com/messages/sig-docs-blog/)
76
+
is there to give guidance on whether a post is appropriate for the Kubernetes blog, so don't
77
+
hesitate to reach out.
78
+
59
79
- Blog posts are not published on specific dates.
60
-
- Articles are reviewed by community volunteers. We'll try our best to accommodate specific timing, but we make no guarantees.
61
-
- 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.
62
-
- 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.
63
-
- Sometimes reviews can get backed up. If you feel your review isn't getting the attention it needs, you can reach out to the blog team via [this slack channel](https://kubernetes.slack.com/messages/sig-docs-blog/) to ask in real time.
80
+
81
+
- Articles are reviewed by community volunteers. We'll try our best to accommodate specific
82
+
timing, but we make no guarantees.
83
+
- Many core parts of the Kubernetes projects submit blog posts during release windows, delaying
84
+
publication times. Consider submitting during a quieter period of the release cycle.
85
+
- If you are looking for greater coordination on post release dates, coordinating with
86
+
[CNCF marketing](https://www.cncf.io/about/contact/) is a more appropriate choice than submitting a blog post.
87
+
- Sometimes reviews can get backed up. If you feel your review isn't getting the attention it needs,
88
+
you can reach out to the blog team via [this slack channel](https://kubernetes.slack.com/messages/sig-docs-blog/)
89
+
to ask in real time.
90
+
64
91
- Blog posts should be relevant to Kubernetes users.
65
-
- Topics related to participation in or results of Kubernetes SIGs activities are always on topic (see the work in the [Upstream Marketing Team](https://github.com/kubernetes/community/blob/master/communication/marketing-team/blog-guidelines.md#upstream-marketing-blog-guidelines) for support on these posts).
66
-
- The components of Kubernetes are purposely modular, so tools that use existing integration points like CNI and CSI are on topic.
67
-
- Posts about other CNCF projects may or may not be on topic. We recommend asking the blog team before submitting a draft.
68
-
- 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.
69
-
- Blog posts about contributing to the Kubernetes project should be in the [Kubernetes Contributors site](https://kubernetes.dev)
92
+
93
+
- Topics related to participation in or results of Kubernetes SIGs activities are always on
94
+
topic (see the work in the [Upstream Marketing Team](https://github.com/kubernetes/community/blob/master/communication/marketing-team/blog-guidelines.md#upstream-marketing-blog-guidelines)
95
+
for support on these posts).
96
+
- The components of Kubernetes are purposely modular, so tools that use existing integration
97
+
points like CNI and CSI are on topic.
98
+
- Posts about other CNCF projects may or may not be on topic. We recommend asking the blog team
99
+
before submitting a draft.
100
+
- Many CNCF projects have their own blog. These are often a better choice for posts. There are
101
+
times of major feature or milestone for a CNCF project that users would be interested in
102
+
reading on the Kubernetes blog.
103
+
- Blog posts about contributing to the Kubernetes project should be in the
- The official blog is not for repurposing existing content from a third party as new content.
72
-
- The [license](https://github.com/kubernetes/website/blob/main/LICENSE) for the blog allows commercial use of the content for commercial purposes, but not the other way around.
109
+
- The [license](https://github.com/kubernetes/website/blob/main/LICENSE) for the blog allows
110
+
commercial use of the content for commercial purposes, but not the other way around.
111
+
73
112
- Blog posts should aim to be future proof
74
-
- Given the development velocity of the project, we want evergreen content that won't require updates to stay accurate for the reader.
75
-
- It can be a better choice to add a tutorial or update official documentation than to write a high level overview as a blog post.
76
-
- Consider concentrating the long technical content as a call to action of the blog post, and focus on the problem space or why readers should care.
113
+
114
+
- Given the development velocity of the project, we want evergreen content that won't require
115
+
updates to stay accurate for the reader.
116
+
- It can be a better choice to add a tutorial or update official documentation than to write a
117
+
high level overview as a blog post.
118
+
- Consider concentrating the long technical content as a call to action of the blog post, and
119
+
focus on the problem space or why readers should care.
77
120
78
121
### Technical Considerations for submitting a blog post
79
122
80
-
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.
123
+
Submissions need to be in Markdown format to be used by the [Hugo](https://gohugo.io/) generator
124
+
for the blog. There are [many resources available](https://gohugo.io/documentation/) on how to use
125
+
this technology stack.
81
126
82
-
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.
127
+
We recognize that this requirement makes the process more difficult for less-familiar folks to
128
+
submit, and we're constantly looking at solutions to lower this bar. If you have ideas on how to
129
+
lower the barrier, please volunteer to help out.
83
130
84
-
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).
131
+
The SIG Docs [blog subproject](https://github.com/kubernetes/community/tree/master/sig-docs/blog-subproject)
132
+
manages the review process for blog posts. For more information, see
133
+
[Submit a post](https://github.com/kubernetes/community/tree/master/sig-docs/blog-subproject#submit-a-post).
85
134
86
135
To submit a blog post follow these directions:
87
136
88
-
-[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.
137
+
-[Open a pull request](/docs/contribute/new-content/open-a-pr/#fork-the-repo) with a new blog post.
138
+
New blog posts go under the [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/main/content/en/blog/_posts)
139
+
directory.
89
140
90
-
- Ensure that your blog post follows the correct naming conventions and the following frontmatter (metadata) information:
141
+
- Ensure that your blog post follows the correct naming conventions and the following frontmatter
142
+
(metadata) information:
91
143
92
-
- 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`.
93
-
- Do **not** include dots in the filename. A name like `2020-01-01-whats-new-in-1.19.md` causes failures during a build.
144
+
- The Markdown file name must follow the format `YYYY-MM-DD-Your-Title-Here.md`. For example,
- Do **not** include dots in the filename. A name like `2020-01-01-whats-new-in-1.19.md` causes
147
+
failures during a build.
94
148
- The front matter must include the following:
95
149
96
-
```yaml
97
-
---
98
-
layout: blog
99
-
title: "Your Title Here"
100
-
date: YYYY-MM-DD
101
-
slug: text-for-URL-link-here-no-spaces
102
-
---
103
-
```
104
-
- 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.
150
+
```yaml
151
+
---
152
+
layout: blog
153
+
title: "Your Title Here"
154
+
date: YYYY-MM-DD
155
+
slug: text-for-URL-link-here-no-spaces
156
+
---
157
+
```
158
+
159
+
- The first or initial commit message should be a short summary of the work being done and
160
+
should stand alone as a description of the blog post. Please note that subsequent edits to
161
+
your blog will be squashed into this main commit, so it should be as useful as possible.
162
+
105
163
- Examples of a good commit message:
106
-
-_Add blog post on the foo kubernetes feature_
107
-
-_blog: foobar announcement_
164
+
- _Add blog post on the foo kubernetes feature_
165
+
- _blog: foobar announcement_
108
166
- Examples of bad commit message:
109
167
- _Add blog post_
110
168
- _._
111
169
- _initial commit_
112
170
- _draft post_
113
-
- 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.
114
-
- 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.
171
+
172
+
- The blog team will then review your PR and give you comments on things you might need to fix.
173
+
After that the bot will merge your PR and your blog post will be published.
174
+
175
+
- If the content of the blog post contains only content that is not expected to require updates
176
+
to stay accurate for the reader, it can be marked as evergreen and exempted from the automatic
177
+
warning about outdated content added to blog posts older than one year.
178
+
115
179
- To mark a blog post as evergreen, add this to the front matter:
116
180
117
181
```yaml
@@ -121,13 +185,15 @@ To submit a blog post follow these directions:
121
185
- **Tutorials** that only apply to specific releases or versions and not all future versions
122
186
- References to pre-GA APIs or features
123
187
124
-
125
188
## Submit a case study
126
189
127
-
Case studies highlight how organizations are using Kubernetes to solve
128
-
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.
190
+
Case studies highlight how organizations are using Kubernetes to solve real-world problems. The
191
+
Kubernetes marketing team and members of the {{< glossary_tooltip text="CNCF" term_id="cncf" >}}
192
+
collaborate with you on all case studies.
129
193
130
194
Have a look at the source for the
131
195
[existing case studies](https://github.com/kubernetes/website/tree/main/content/en/case-studies).
132
196
133
-
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.
197
+
Refer to the [case study guidelines](https://github.com/cncf/foundation/blob/master/case-study-guidelines.md)
198
+
and submit your request as outlined in the guidelines.
0 commit comments