Skip to content

Commit 4a60a47

Browse files
authored
Merge pull request #7605 from sftim/20231114_update_blog_community_details
Update details around blog contribution
2 parents 9a9f782 + adc6ebe commit 4a60a47

File tree

3 files changed

+58
-39
lines changed

3 files changed

+58
-39
lines changed

communication/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,9 @@ community call, and more [YouTube Guidelines].
129129

130130
#### Kubernetes Blog
131131

132-
The [Kubernetes Blog] is owned by sig-docs and operated by the [blog team].
132+
The [Kubernetes Blog] is owned by SIG Docs and operated by the [blog team].
133133

134-
[submit a blog post] | [2018 blog metrics]
134+
[submit a blog post]
135135

136136
## Misc Community Resources
137137
### Issues & Troubleshooting

communication/contributor-comms/blogging-resources/blog-guidelines.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ existing tools and processes, and in general tips and suggestions on
1616
how to collaborate.
1717

1818
Other types of content, like Kubernetes capabilities, tutorials, and
19-
technical articles, are better suited for the [SIG-Docs blogging
19+
technical articles, are better suited for the [SIG Docs blogging
2020
initiative](/sig-docs/blog-subproject/README.md).
2121

2222
## Where to publish
@@ -85,6 +85,9 @@ follows:
8585
guide](https://kubernetes.io/docs/contribute/style/style-guide/):
8686
these guidelines can help in improving the readability of your
8787
article, especially in terms of the use of Kubernetes terminology.
88+
You can also read
89+
[Submitting blog posts and case studies](https://kubernetes.io/docs/contribute/new-content/blogs-case-studies/)
90+
for extra context.
8891
4. Once you have reflected any feedback in the proposal draft,
8992
announce that the article is ready for submission (again, in the
9093
channel or in one of the weekly meetings): the assigned editor will
@@ -121,7 +124,7 @@ co-author](https://docs.github.com/en/pull-requests/committing-changes-to-your-p
121124
is done by adding `Co-authored-by: original-author-name
122125
<[email protected]>` to the commit message.
123126

124-
The number of PRs depends on where the article will be published:
127+
The number of PRs you open depends on where the article will be published:
125128

126129
1. If it's solely for the Contributor site: the PR should be opened in
127130
the
@@ -130,7 +133,7 @@ The number of PRs depends on where the article will be published:
130133
2. If it's to be mirrored in the main Kubernetes blog: after the
131134
previous step, a new PR is opened on
132135
[kubernetes/website](https://github.com/kubernetes/website),
133-
mentioning the original PR. The SIG-Docs Blog editorial team will,
136+
mentioning the original PR. Reviewers from SIG Docs Blog will,
134137
in this case, already been notified and involved in the initial PR.
135138

136139

@@ -186,7 +189,9 @@ Keep the following points in mind as you write in order to speed up the review p
186189
* As the author, never talk about your employer, sell, promote, or
187190
pitch; this is about upstream community endeavours and the
188191
individuals and groups that create it
189-
* Follow the [documentation style guide](https://kubernetes.io/docs/contribute/style/style-guide/).
192+
* Follow the [documentation style guide](https://kubernetes.io/docs/contribute/style/style-guide/);
193+
for blog articles these are informative guidelines rather than anything more strict, but
194+
it's still good to follow them where appropriate.
190195

191196
## Further Recommendations
192197

sig-docs/blog-subproject/README.md

Lines changed: 47 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,108 @@
11
# Kubernetes Blog Subproject
22

3-
The Kubernetes Blog Subproject is owned by [SIG-Docs](https://github.com/kubernetes/community/tree/master/sig-docs) and run by the [Editorial Team](#leadership).
3+
The Kubernetes Blog Subproject is owned by [SIG Docs](https://github.com/kubernetes/community/tree/master/sig-docs).
44

55
This section covers documentation, processes, and roles for the [Kubernetes blog](https://kubernetes.io/blog/).
66

77
## Meetings
88

9-
Regular Blog Meeting: Tuesdays at 18:30 UTC (biweekly). [Convert Your Timezone](http://www.thetimezoneconverter.com/?t=18:30&tz=UTC)
9+
See [meetings](/kubernetes/community/tree/master/sig-docs#meetings) for SIG Docs
1010

11-
- [Meeting notes and Agenda](https://docs.google.com/document/d/1W5MKkaQGd3YKKZINzj1tJAQbql5R_Y4KAHlFNsJ44Bc/edit?usp=sharing)
12-
- [Meeting recordings](https://www.youtube.com/playlist?list=PL69nYSiGNLP3b5hlx0YV7Lo7DtckM84y8)
1311

14-
## Leadership
12+
## Subproject contributors
1513

16-
- **Technical Editors:** [Bob Killen](https://github.com/mrbobbytables), [Taylor Dolezal](https://github.com/onlydole), [Tim Bannister](https://github.com/sftim), [Nate Waddington](https://github.com/nate-double-u)
14+
<!-- GitHub username alphabetical order -->
15+
- **Blog approvers:** [Bob Killen](https://github.com/mrbobbytables), [Taylor Dolezal](https://github.com/onlydole),
16+
[Nate Waddington](https://github.com/nate-double-u), [Tim Bannister](https://github.com/sftim)
17+
18+
- **Blog shadow approvers:** _no contributors_
19+
20+
- **Blog editors:** _no contributors_
21+
22+
- **Blog shadow editors:** _no contributors_
23+
24+
✨ Could **you** join the blog editorial team?
1725

1826
## Contact
1927

2028
- Slack: [#sig-docs-blog](https://kubernetes.slack.com/messages/CJDHVD54J)
2129
- Mailing List: [[email protected]](mailto:[email protected])
2230
- Open Community Issues/PRs: [`is:open repo:kubernetes/website label:area/blog`](https://github.com/issues?q=is%3Aopen+label%3Aarea%2Fblog+repo%3Akubernetes%2Fwebsite)
23-
- GitHub Teams: [@kubernetes/kubernetes-blog](https://github.com/orgs/kubernetes/teams/kubernetes-blog), [@kubernetes/kubernetes-blog-maintainers](https://github.com/orgs/kubernetes/teams/kubernetes-blog-maintainers)
2431

2532
## Submit a Post
2633

2734
Anyone can write a blog post and submit it for review. Blog posts should not be commercial in nature and should consist of content that will apply broadly to the Kubernetes community.
2835

29-
To submit a blog post, follow the steps below.
36+
To propose a blog post, read [Submitting blog posts and case studies](https://k8s.io/docs/contribute/new-content/blogs-case-studies/).
3037

31-
1. [Sign the CLA](https://kubernetes.io/docs/contribute/start/#sign-the-cla) if you have not yet done so.
32-
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).
33-
1. Write out your blog post in a text editor of your choice.
34-
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.
35-
1. When you save the file, GitHub will walk you through the pull request process.
36-
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.
38+
### Article guidelines
3739

38-
### Blog Guidelines
40+
**Original content only**. You cannot submit a blog article that has been published elsewhere. The Kubernetes project
41+
makes exception to this only for articles posted to the CNCF blog or to the [Kubernetes contributor blog](https://k8s.dev/blog/).
3942

40-
Requested Content (with examples):
43+
Requested content:
4144

4245
- New Kubernetes capabilities
4346
- Kubernetes projects updates
4447
- Updates from Special Interest Groups
4548
- Tutorials and walkthroughs
4649
- Thought leadership around Kubernetes
4750
- Kubernetes Partner OSS integration
48-
- **Original content only**
4951

50-
Unsuitable Content:
52+
Unsuitable content:
5153

5254
- Vendor product pitches
5355
- Partner updates without an integration and customer story
54-
- Syndicated posts (language translations ok)
56+
- Syndicated posts (it's OK to localized existing articles from English)
5557

56-
## Review Process
58+
## Review process
5759

5860
Once a blog post is submitted either via the form or a PR, it will be routed to the editorial team for review either via email for Google Docs or auto-assigning for a PR.
5961

60-
Each blog post requires a LGTM from one copy editor, technical editor\*, and blog community manager. Once the necessary LGTMs are in place, an Editorial Lead will schedule and approve the blog post.
62+
Each blog post requires a LGTM from a blog editor (or approver) and an approval by a blog approver. Blog editors will usually also get a technical review from the appropriate SIG.
6163

6264
_If a blog post does not contain any technical content (for example, [How You Can Help Localize Kubernetes Docs](https://kubernetes.io/blog/2019/04/26/how-you-can-help-localize-kubernetes-docs/)), the technical review can be omitted._
6365

64-
### Embargoed Content
66+
Articles should merge _before_ their publication date; automation picks up scheduled posts and publishes them automatically.
67+
68+
69+
### Release communications
70+
71+
SIG Release lead on blog articles to announce Kubernetes releases, and the post-release series of articles. SIG Docs and the blog subproject support
72+
that process and provide approvals for upcoming articles.
73+
74+
### Embargoed content
75+
76+
The blog repository on GitHub is public, therefore any content that needs to remain confidential until a certain time (for example: release posts, security vulnerabilities) should be proposed by email message to [[email protected]](mailto:[email protected]). If you need to, you can also send a Slack direct message to the set of blog approvers; please do this sparingly.
6577

66-
The blog repository on GitHub is public, therefore any content that needs to remain confidential until a certain time (for example: release posts, security vulnerabilities) should be proposed by email message to [[email protected]](mailto:[email protected]). In your message, please note the time that the embargo will be lifted.
78+
In your message, please note the time that the embargo will be lifted.
6779

6880
### SLA
6981

70-
Blog posts can take up to **2 weeks** to review. If you’d like to request an expedited review, please email [blog@kubernetes.io](mailto:[email protected]).
82+
Blog posts can take up to **4 weeks** to review. If you’d like to request an expedited review, please get in touch via [#sig-docs-blog](https://app.slack.com/client/T09NY5SBT/CJDHVD54J) on the Kubernetes Slack workspace.
7183

72-
## Ongoing Blog Maintenance
84+
## Ongoing blog maintenance
7385

74-
SIG-Docs approvers for English content can approve edits after the fact such as: broken links, copy edits, etc. However, approval and editorial review for new blog posts is limited to the Blog Team.
86+
SIG Docs approvers for English content can approve edits after the fact such as: broken links, copy edits, etc. However, approval and editorial review for new blog posts is limited to the Blog Team.
7587

76-
We typically do not make edits to blog posts more than 1 years old.
88+
We typically do not make edits to blog posts more than 1 years old; there is an exception for articles marked `evergreen: true` in their
89+
[front matter](https://gohugo.io/content-management/front-matter/).
7790

78-
## Editorial Team Selection
91+
## Editorial team selection
7992

80-
Each Editorial Team role is responsible for staffing their respective role, with this order of fall-through in mind:
93+
Bloggers and reviewer responsibilities include staffing the team, with this order of fall-through in mind:
8194

8295
- training and selecting a successor from the current pool of role shadows
8396
- training and selecting a successor from non-Editorial Team members
8497
- staffing the role themselves
8598

86-
Ultimately, if none of these can be satisfied, responsibility falls to the Editorial Team Lead and SIG-Docs to staff the roles.
99+
Ultimately, if none of these can be satisfied, responsibility falls to the SIG Docs leadership to staff the roles.
87100

88101
### Shadows
89102

90-
We are always open to adding new shadows to the editorial team roles. If you are interested in shadowing one of the roles on the team, please fill out [this application](The application form is now live for anyone interested in joining the blog editorial team: https://docs.google.com/forms/d/e/1FAIpQLScg9fHsyW-LlsBF8rc9J0sR8u3O3g17lwFUKIE-qrjL6Z-AyA/viewform?usp=sf_link). We review applications on a rolling basis.
103+
We are always open to adding new shadows to the editorial team roles. If you are interested in shadowing one of the roles on the team, please say Hi in
104+
[#sig-docs-blog](https://app.slack.com/client/T09NY5SBT/CJDHVD54J) on the Kubernetes Slack workspace. Visit https://slack.k8s.io/ for an invitation if you are not already part of the workspace.
91105

92-
### Removing a Team Member
106+
### Removing a team member
93107

94-
If a team member can no longer fulfill their duties, the role defaults to the shadow.
108+
If all members of a group (eg approvers) can no longer fulfil their duties, and there is a shadow for that role, that role defaults to the shadow.

0 commit comments

Comments
 (0)