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/en/docs/contribute/new-content/blogs-case-studies.md
+66-31Lines changed: 66 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,35 +12,77 @@ weight: 30
12
12
Anyone can write a blog post and submit it for review.
13
13
Case studies require extensive review before they're approved.
14
14
15
-
16
-
17
15
<!-- body -->
18
16
19
-
## Write a blog post
20
-
21
-
Blog posts should not be
22
-
vendor pitches. They must contain content that applies broadly to
23
-
the Kubernetes community. 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).
24
-
25
-
To submit a blog post, you can either:
17
+
## The Kubernetes Blog
26
18
27
-
- Use the
28
-
[Kubernetes blog submission form](https://docs.google.com/forms/d/e/1FAIpQLSdMpMoSIrhte5omZbTE7nB84qcGBy8XnnXhDFoW0h7p2zwXrw/viewform)
29
-
-[Open a pull request](/docs/contribute/new-content/new-content/#fork-the-repo) with a new blog post. Create new blog posts in the [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/master/content/en/blog/_posts) directory.
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!
30
22
31
-
If you open a pull request, ensure that your blog post follows the correct naming conventions and frontmatter information:
23
+
Anyone can write a blog post and submit it for review.
32
24
33
-
- The markdown file name must follow the format `YYY-MM-DD-Your-Title-Here.md`. For example, `2020-02-07-Deploying-External-OpenStack-Cloud-Provider-With-Kubeadm.md`.
34
-
- The front matter must include the following:
25
+
### Guidelines and expectations
26
+
27
+
- Blog posts should not be vendor pitches.
28
+
- 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](https://kubernetes.io/docs/contribute/style/content-guide/#what-s-allowed) for what is typically allowed on Kubernetes properties.
29
+
- 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.
30
+
- 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.
31
+
- Blog posts are not published on specific dates.
32
+
- Articles are reviewed by community volunteers. We'll try our best to accommodate specific timing, but we make no guarantees.
33
+
- 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.
34
+
- 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.
35
+
- 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.
36
+
- Blog posts should be relevant to Kubernetes users.
37
+
- 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).
38
+
- The components of Kubernetes are purposely modular, so tools that use existing integration points like CNI and CSI are on topic.
39
+
- Posts about other CNCF projects may or may not be on topic. We recommend asking the blog team before submitting a draft.
40
+
- 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.
41
+
- Blog posts should be original content
42
+
- The official blog is not for repurposing existing content from a third party as new content.
43
+
- The [license](https://github.com/kubernetes/website/blob/master/LICENSE) for the blog does allow commercial use of the content for commercial purposes, just not the other way around.
44
+
- Blog posts should aim to be future proof
45
+
- Given the development velocity of the project, we want evergreen content that won't require updates to stay accurate for the reader.
46
+
- 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.
47
+
- 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.
48
+
49
+
### Technical Considerations for submitting a blog post
50
+
51
+
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.
52
+
53
+
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.
54
+
55
+
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).
56
+
57
+
To submit a blog post follow these directions:
58
+
59
+
-[Open a pull request](/docs/contribute/new-content/new-content/#fork-the-repo) with a new blog post. New blog posts go under the [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/master/content/en/blog/_posts) directory.
60
+
61
+
- Ensure that your blog post follows the correct naming conventions and the following frontmatter (metadata) information:
62
+
63
+
- 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`.
64
+
- Do **not** include dots in the filename. A name like `2020-01-01-whats-new-in-1.19.md` causes failures during a build.
65
+
- The front matter must include the following:
66
+
67
+
```yaml
68
+
---
69
+
layout: blog
70
+
title: "Your Title Here"
71
+
date: YYYY-MM-DD
72
+
slug: text-for-URL-link-here-no-spaces
73
+
---
74
+
```
75
+
- 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.
76
+
- Examples of a good commit message:
77
+
-_Add blog post on the foo kubernetes feature_
78
+
-_blog: foobar announcement_
79
+
- Examples of bad commit message:
80
+
-_Add blog post_
81
+
-_._
82
+
-_initial commit_
83
+
-_draft post_
84
+
- 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.
35
85
36
-
```yaml
37
-
---
38
-
layout: blog
39
-
title: "Your Title Here"
40
-
date: YYYY-MM-DD
41
-
slug: text-for-URL-link-here-no-spaces
42
-
---
43
-
```
44
86
45
87
## Submit a case study
46
88
@@ -50,11 +92,4 @@ real-world problems. The Kubernetes marketing team and members of the {{< glossa
50
92
Have a look at the source for the
51
93
[existing case studies](https://github.com/kubernetes/website/tree/master/content/en/case-studies).
52
94
53
-
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.
54
-
55
-
56
-
57
-
## {{% heading "whatsnext" %}}
58
-
59
-
60
-
95
+
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.
0 commit comments