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
This initiative falls under the [Contributor Comms Charter](./CHARTER.md).
4
4
5
-
We are looking for Kubernetes-curious community members who are **interested in writing** and **care about getting the word out** to our huge community of users, developers, and contributors of all types. Here's how to get involved.
5
+
We are looking for Kubernetes-curious community members who are
6
+
**interested in writing** and **care about getting the word out** to
7
+
our huge community of users, developers, and contributors of all
8
+
types. Here's how to get involved.
6
9
7
10
## Requested Content
8
11
9
-
We are looking for content related to the contributor experience and with increasing the visibility of Kubernetes and how it is developed: this includes interviews with SIGs, articles on how to better use existing tools and processes, and in general tips and suggestions on how to collaborate.
12
+
We are looking for content related to the contributor experience and
13
+
with increasing the visibility of Kubernetes and how it is developed:
14
+
this includes interviews with SIGs, articles on how to better use
15
+
existing tools and processes, and in general tips and suggestions on
16
+
how to collaborate.
10
17
11
-
Other types of content, like Kubernetes capabilities, tutorials, and technical articles, are better suited for the [SIG-Docs blogging initiative](/sig-docs/blog-subproject/README.md).
18
+
Other types of content, like Kubernetes capabilities, tutorials, and
19
+
technical articles, are better suited for the [SIG-Docs blogging
20
+
initiative](/sig-docs/blog-subproject/README.md).
12
21
13
22
## Where to publish
14
23
15
-
As mentioned, the focus of the Contributor Experience articles is targeted at those that contribute to Kubernetes, but sometimes it's not obvious where a specific theme will fit. The following are the most common situations:
16
-
17
-
1. Article is just for [k8s.dev](http://k8s.dev/blog): this is when it is relevant for the contributor community, and not necessarily for Kubernetes end-users. An example is an article explaining how to use some specific tool or automation that helps with the Kubernetes development process.
18
-
2. Article is just for [kubernetes.io](https://kubernetes.io/blog/): when the article targets Kubernetes end-users, and not specifically the contributor community. Examples include most technical articles on Kubernetes features, updates on new features and deprecations, etc.
19
-
3. Article is relevant for both: sometimes, an article will be relevant to both the Kubernetes end-users, and the contributor community. Examples include interviews with SIGs and WGs, articles on technical aspects that are important for the contributor community, etc.
20
-
21
-
The decision on what is the right option will be made jointly by the SIG Contribex Comms and the SIG Docs Blogging editorial team: as a content writer you shouldn't be overly concerned about it, except in how it can change the approval process, as described below.
24
+
As mentioned, the focus of the Contributor Experience articles is
25
+
targeted at those that contribute to Kubernetes, but sometimes it's
26
+
not obvious where a specific theme will fit. The following are the
27
+
most common situations:
28
+
29
+
1. Article is just for [k8s.dev](http://k8s.dev/blog): this is when it
30
+
is relevant for the contributor community, and not necessarily for
31
+
Kubernetes end-users. An example is an article explaining how to
32
+
use some specific tool or automation that helps with the Kubernetes
33
+
development process.
34
+
2. Article is just for [kubernetes.io](https://kubernetes.io/blog/):
35
+
when the article targets Kubernetes end-users, and not specifically
36
+
the contributor community. Examples include most technical articles
37
+
on Kubernetes features, updates on new features and deprecations,
38
+
etc.
39
+
3. Article is relevant for both: sometimes, an article will be
40
+
relevant to both the Kubernetes end-users, and the contributor
41
+
community. Examples include interviews with SIGs and WGs, articles
42
+
on technical aspects that are important for the contributor
43
+
community, etc.
44
+
45
+
The decision on what is the right option will be made jointly by the
46
+
SIG Contribex Comms and the SIG Docs Blogging editorial team: as a
47
+
content writer you shouldn't be overly concerned about it, except in
48
+
how it can change the approval process, as described below.
22
49
23
50
## Submission and review process
24
51
25
-
The quickest way to get involved is to let the team in [#sig-contribex-comms](https://kubernetes.slack.com/archives/C03KT3SUJ20) know that you have an idea for an article; the team will identify the best target for your submission and liaison with the necessary teams, if needed. To reduce the amount of editing done directly in GitHub, a two-stage approach is highly recommended.
26
-
27
-
This process is initiated in [#sig-contribex-comms](https://kubernetes.slack.com/archives/C03KT3SUJ20) and uses the processes from the SIG Docs blog [subproject](/sig-docs/blog-subproject/README.md), and is broadly as follows:
28
-
29
-
1. Present your idea to the community, by going to the [#sig-contribex-comms](https://kubernetes.slack.com/archives/C03KT3SUJ20) Slack channel, or by joining the [weekly meeting](https://docs.google.com/document/d/1KDoqbw2A6W7rLSbIRuOlqH8gkoOnp2IHHuV9KyJDD2c). This will make it easier to coordinate effort and avoid duplicate effort, as well as to gather initial suggestions around the article scope.
30
-
2. The submission idea will be reviewed by the team, including the decision on where to publish it; someone from the SIG Contribex Comms team will reach out to the [#sig-docs-blog](https://kubernetes.slack.com/archives/CJDHVD54J) editorial team to clarify if the content is adequate for republishing in the main Kubernentes blog. At this stage an editor should be assigned to follow-up the process with you.
31
-
3. Create your proposal draft in [Google Docs](https://docs.google.com/) or HackMD (https://hackmd.io), and ask for a review in [the channel](https://kubernetes.slack.com/archives/C03KT3SUJ20). This will facilitate easier editing, especially if major changes or restructuring is needed. Take into account the [documentation style guide](https://kubernetes.io/docs/contribute/style/style-guide/): these guidelines can help in improving the readability of your article, especially in terms of the use of Kubernetes terminology.
32
-
4. Once you have reflected any feedback in the proposal draft, announce that the article is ready for submission (again, in the channel or in one of the weekly meetings): the assigned editor will use the final text to open the PR, adding you as a Co-author.
33
-
5. (Optional) If the submission will be mirrored in the main Kubernetes site, a second PR will be opened by the editor, but on the main repository, and after being approved in the `contributor-site` one.
34
-
35
-
For now, our official process is to use [SIG Docs' system](/sig-docs/blog-subproject/README.md), with one change: instead of directly creating the file in the Kubernetes site repository, as instructed above it's initially created in the [contributor-site](https://github.com/kubernetes/contributor-site), in the appropriate folder (i.e. the right year in `contributor-site/content/en/blog/`).
36
-
37
-
This will lead to an initial review process before it gets mirrored to the main Kubernetes site.
52
+
The quickest way to get involved is to let the team in
these guidelines can help in improving the readability of your
87
+
article, especially in terms of the use of Kubernetes terminology.
88
+
4. Once you have reflected any feedback in the proposal draft,
89
+
announce that the article is ready for submission (again, in the
90
+
channel or in one of the weekly meetings): the assigned editor will
91
+
use the final text to open the PR, adding you as a Co-author.
92
+
5. (Optional) If the submission will be mirrored in the main
93
+
Kubernetes site, a second PR will be opened by the editor, but on
94
+
the main repository. The content of both should be the same, with
95
+
the applicable differences (e.g., file location, metadata). The
96
+
review process primarily happens in the `contributor-site` PR, with
97
+
all the changes then copied over to the `website` after approval.
98
+
99
+
For now, our official process is to use [SIG Docs'
100
+
system](/sig-docs/blog-subproject/README.md), with one change: instead
101
+
of directly creating the file in the Kubernetes site repository, as
102
+
instructed above it's initially created in the
103
+
[contributor-site](https://github.com/kubernetes/contributor-site), in
104
+
the appropriate folder (i.e. the right year in
105
+
`contributor-site/content/en/blog/`).
106
+
107
+
This will lead to an initial review process before it gets mirrored to
108
+
the main Kubernetes site.
38
109
39
110
### Editor instructions
40
111
41
-
Once the text is final, an editor will open the PR. This facilitates the approval process and prevents articles with massive restructuring or changes needed to be submitted to GitHub, something that makes the review process substantially more difficult.
112
+
Once the text is final, an editor will open the PR. This facilitates
113
+
the approval process and prevents articles with massive restructuring
114
+
or changes needed to be submitted to GitHub, something that makes the
115
+
review process substantially more difficult.
116
+
117
+
In order to keep the authorship information (which will make the
118
+
submission count towards the contribution of the article author),
119
+
editors must [add the original author as a
120
+
co-author](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors). This
121
+
is done by adding `Co-authored-by: original-author-name
In order to keep the authorship information (which will make the submission count towards the contribution of the article author), editors must [add the original author as a co-author](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors). This is done by adding `Co-authored-by: original-author-name <[email protected]>` to the commit message.
44
-
45
124
The number of PRs depends on where the article will be published:
46
125
47
-
1. If it's solely for the Contributor site: the PR should be opened in the [contributor-site](https://github.com/kubernetes/contributor-site), after which the process ends.
48
-
2. If it's to be mirrored in the main Kubernetes blog: after the previous step, a new PR is opened on [kubernetes/website](https://github.com/kubernetes/website), mentioning the original PR. The SIG-Docs Blog editorial team will, in this case, already been notified and involved in the initial PR.
126
+
1. If it's solely for the Contributor site: the PR should be opened in
mentioning the original PR. The SIG-Docs Blog editorial team will,
134
+
in this case, already been notified and involved in the initial PR.
49
135
50
136
51
137
## Blogger Expectations, Responsibilities, and Information
@@ -54,18 +140,27 @@ Anyone is welcome to contribute when they have time.
54
140
55
141
If you would like to be listed as a member of the team, here are the expectations:
56
142
57
-
1. Be prepared to write one blog a quarter and participate in edits to other articles. The time commitment is typically 5-10 hours per quarter depending on the number of blog posts in the review queue.
58
-
2. Bloggers are expected to attend at least one Contributor Comms team meeting a month or check-in to remain active.
59
-
3. Remain non-partial: if you receive a request to write about a project, an individual, or a group of people from your employer, you should ask an impartial blogger to write it.
60
-
4. As with all contribution to Kubernetes, adhere to the [code of conduct](/code-of-conduct.md), values, and principles of the project.
143
+
1. Be prepared to write one blog a quarter and participate in edits to
144
+
other articles. The time commitment is typically 5-10 hours per
145
+
quarter depending on the number of blog posts in the review queue.
146
+
2. Bloggers are expected to attend at least one Contributor Comms team
147
+
meeting a month or check-in to remain active.
148
+
3. Remain non-partial: if you receive a request to write about a
149
+
project, an individual, or a group of people from your employer,
150
+
you should ask an impartial blogger to write it.
151
+
4. As with all contribution to Kubernetes, adhere to the [code of
152
+
conduct](/code-of-conduct.md), values, and principles of the
153
+
project.
61
154
62
155
## How to Write an Effective Blog
63
156
64
157
Keep the following points in mind as you write in order to speed up the review process:
65
158
66
159
* Use inclusive language understandable by everyone
67
-
* Rephrase gendered pronouns (change "he" or "she" to "they" or adjust to remove)
68
-
* Remember nothing is simple when you're starting out (remove "just," "simply", and "easy")
160
+
* Rephrase gendered pronouns (change "he" or "she" to "they" or
161
+
adjust to remove)
162
+
* Remember nothing is simple when you're starting out (remove
163
+
"just," "simply", and "easy")
69
164
* Define terminology or acronyms (do not assume people know what a term means)
70
165
* Shy away from jargon and colloquial expressions
71
166
* Write clearly and avoid ambiguous sentences
@@ -74,19 +169,30 @@ Keep the following points in mind as you write in order to speed up the review p
74
169
* Design a beginning, middle, and end to your story with a clear call to action
75
170
* Provide evidence and data where applicable, to back up your message
76
171
* Make the article visually appealing
77
-
* Include at least one image (and use public domain or Creative Commons licensed ones)
78
-
* Prefer inclusive images like those from [WOCinTech](https://www.flickr.com/photos/wocintechchat/) and [Queer in Tech](https://www.flickr.com/photos/mapbox/albums/72157713100349311)
79
-
* Find images on sites like [Creative Commons](https://search.creativecommons.org/), [Pexels](https://www.pexels.com/public-domain-images/), and [Unsplash](https://unsplash.com/images/stock/public-domain))
172
+
* Include at least one image (and use public domain or Creative
173
+
Commons licensed ones)
174
+
* Prefer inclusive images like those from
175
+
[WOCinTech](https://www.flickr.com/photos/wocintechchat/) and
* Ensure that the blog post is reviewed by the anyone being mentioned in the piece
84
-
* As the author, never talk about your employer, sell, promote, or pitch; this is about upstream community endeavours and the individuals and groups that create it
186
+
* As the author, never talk about your employer, sell, promote, or
187
+
pitch; this is about upstream community endeavours and the
188
+
individuals and groups that create it
85
189
* Follow the [documentation style guide](https://kubernetes.io/docs/contribute/style/style-guide/).
86
190
87
191
## Further Recommendations
88
192
89
193
The following are helpful resources for authoring articles:
90
194
91
-
*[Creating Quality Content (For Search Engines and People)](https://moz.com/blog/quality-blog-content)
92
-
*[How to write effective documentation for your open source project](https://opensource.com/article/20/3/documentation)
195
+
*[Creating Quality Content (For Search Engines and
0 commit comments