Skip to content

Commit 3c0890d

Browse files
author
Kaitlyn Barnard
committed
Adding proposed files for Kubernetes blog subproject
1 parent cfd82ed commit 3c0890d

File tree

5 files changed

+211
-0
lines changed

5 files changed

+211
-0
lines changed

sig-docs/blog-subproject/README.md

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
The Kubernetes Blog Subproject is owned by SIG-Docs and run by the Editorial Team.
2+
3+
This section covers documentation, processes, and roles for the Kubernetes blog.
4+
5+
## Meetings
6+
7+
Regular Blog Meeting: TBD (biweekly).
8+
9+
* Meeting notes and Agenda
10+
* Meeting recording
11+
12+
## Leadership
13+
14+
**Editorial Leads:** [Kaitlyn Barnard](https://github.com/kbarnard10), [Zach Corleissen](https://github.com/zacharysarah) (shadow)
15+
**Technical Editors:** [Bob Killen](https://github.com/mrbobbytables)
16+
**Copy Editors:** [Alex Handy](https://github.com/vonguard), [Cody Clark](https://github.com/cody-clark)
17+
**Blog Community Managers:** [Jorge Castro](https://github.com/castrojo), [Paris Pittman](https://github.com/parispittman) (shadow)
18+
19+
## Contact
20+
21+
Slack: #kubernetes-docs-blog
22+
Mailing List: [[email protected]](mailto:[email protected])
23+
Open Community Issues/PRs: area/blog label
24+
GitHub Team: @kubernetes/sig-docs-blog-reviews
25+
26+
## Submit a Post
27+
28+
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.
29+
30+
To submit a blog post, you can either submit it using the [Kubernetes blog submission form](https://docs.google.com/forms/d/e/1FAIpQLSch_phFYMTYlrTDuYziURP6nLMijoXx_f7sLABEU5gWBtxJHQ/viewform), or follow the steps below.
31+
32+
1. [Sign the CLA](https://kubernetes.io/docs/contribute/start/#sign-the-cla) if you have not yet done so.
33+
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).
34+
1. Write out your blog post in a text editor of your choice.
35+
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.
36+
1. When you save the file, GitHub will walk you through the pull request process.
37+
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+
39+
### Blog Guidelines
40+
41+
Requested Content (with examples):
42+
43+
* New Kubernetes capabilities
44+
* Kubernetes projects updates
45+
* Updates from Special Interest Groups
46+
* Tutorials and walkthroughs
47+
* Thought leadership around Kubernetes
48+
* Kubernetes Partner OSS integration
49+
* **Original content only**
50+
51+
Unsuitable Content:
52+
53+
* Vendor product pitches
54+
* Partner updates without an integration and customer story
55+
* Syndicated posts (language translations ok)
56+
57+
## Review Process
58+
59+
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.
60+
61+
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+
63+
_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._
64+
65+
### Embargoed Content
66+
67+
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 submitted via the form directly. On [the form](https://docs.google.com/forms/d/e/1FAIpQLSch_phFYMTYlrTDuYziURP6nLMijoXx_f7sLABEU5gWBtxJHQ/viewform), please note the time that the embargo will be lifted. In this case, the editorial team will do all reviews in Google Docs. If this is time sensitive, please email [[email protected]](mailto:[email protected]).
68+
69+
### SLA
70+
71+
Blog posts can take up to **2 weeks** to review. If you’d like to request an expedited review, please email [[email protected]](mailto:[email protected]).
72+
73+
## Ongoing Blog Maintenance
74+
75+
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.
76+
77+
We typically do not make edits to blog posts more than 1 years old.
78+
79+
## Editorial Team Selection
80+
81+
Each Editorial Team role is responsible for staffing their respective role, with this order of fall-through in mind:
82+
83+
* training and selecting a successor from the current pool of role shadows
84+
* training and selecting a successor from non-Editorial Team members
85+
* staffing the role themselves
86+
87+
Ultimately, if none of these can be satisfied, responsibility falls to the Editorial Team Lead and SIG-Docs to staff the roles.
88+
89+
### Shadows
90+
91+
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](TBD). We review applications on a rolling basis.
92+
93+
### Removing a Team Member
94+
95+
If a team member can no longer fulfill their duties, the role defaults to the shadow.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Blog Community Manager
2+
3+
## Overview
4+
5+
The Blog Community Manager ensures that the editorial process is transparent, content serves the best interests of the community, and advocates for blog awareness and participation.
6+
7+
## Authority and Responsibility
8+
9+
* Ensure that content best represents the best interests of the community and is not driven by commercial interests.
10+
* LGTM blog posts once it is approved from a community perspective.
11+
12+
## Skills and Experience Required
13+
14+
* Strong written and verbal communication skills are required.
15+
* A working knowledge of Kubernetes concepts.
16+
* A working knowledge of GitHub.
17+
* Strong knowledge of the Kubernetes community and overall cloud native ecosystem.
18+
* This role should be filled by someone outside of CNCF when the editorial lead is a CNCF employee.
19+
20+
## Activities
21+
22+
* Attending and participating in biweekly editorial meetings.
23+
* Providing a review of all blog posts to ensure they meet the content guidelines and best interests of the community.
24+
* Work with the editorial leads to maintain transparency in the review process and proposing any necessary updates to the blog guidelines.
25+
* Advocating for the blog as a place for contributors to get involved and share educational content with the community.
26+
27+
## Time Commitments
28+
29+
The time commitment is typically 5-10 hours per quarter depending on the number of blog posts in the review queue.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Copy Editor
2+
3+
## Overview
4+
5+
The copy editor is the expert in spelling, grammar, and flow to ensure that all blog posts meet a high standard of quality and maintain a consistent tone of voice across the blog.
6+
7+
## Authority and Responsibility
8+
9+
* Ensure that content adheres to a high-level of quality with proper spelling, grammar, and logical flow of content.
10+
* Own the “tone of voice” of the blog, ensuring all content has a consistent feel while maintaining the unique voice of each contributor.
11+
* LGTM blog posts once it is approved from a grammar and spelling perspective.
12+
13+
## Skills and Experience Required
14+
15+
* Strong written and verbal communication skills are required.
16+
* Proficiency in English spelling and grammar.
17+
* A working knowledge of Kubernetes concepts.
18+
* A working knowledge of GitHub.
19+
20+
## Activities
21+
22+
* Attending and participating in biweekly editorial meetings
23+
* Providing a copy review on all blog posts.
24+
25+
## Time Commitments
26+
27+
The time commitment is typically 5-10 hours per quarter depending on the number of blog posts in the review queue.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Editorial Lead
2+
3+
## Overview
4+
5+
The Editorial Lead is responsible for the day-to-day management of the Kubernetes blog. This includes managing the editorial process and assembling the editorial team.
6+
7+
## Authority and Responsibility
8+
9+
* Ensure the editorial process runs smoothly and blogs are reviewed in a timely manner in accordance with the SLA.
10+
* Approve and schedule blog posts based on the editorial calendar.
11+
12+
## Skills and Experience Required
13+
14+
* Strong written and verbal communication skills are required.
15+
* Strong knowledge of the Kubernetes community and overall cloud native ecosystem.
16+
* Prior experience in blog management, such as PR or Marketing is extremely helpful.
17+
* Proficiency in GitHub and Git.
18+
* To properly serve as an Editorial Lead, you must have the following Kubernetes-specific qualifications:
19+
* If you haven’t held an editorial team role, you must shadow the release lead for two full quarters.
20+
* If you have held an editorial team role, you must shadow the release lead for one full quarter.
21+
* You must be a member in good standing, and part of the Kubernetes org.
22+
* You must be a member of the kubernetes-dev mailing list.
23+
24+
## Activities
25+
26+
* Scheduling and running biweekly editorial meetings.
27+
* Reviewing, assigning, and scheduling blog posts.
28+
* Final approval on blog posts.
29+
* Maintain blog documentation and process guidelines.
30+
* Advocating for the blog as a place for contributors to get involved and share educational content with the community.
31+
32+
## Time Commitments
33+
34+
The time commitment is typically 10-15 hours per quarter depending on the number of blog posts in the review queue.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Technical Editor
2+
3+
## Overview
4+
5+
The technical editor is the subject matter expert to ensure the technical accuracy of content.
6+
7+
## Authority and Responsibility
8+
9+
* Ensure that content adheres to a high-level of technical accuracy and technical terminology is used consistently across the blog.
10+
* Assign out to the proper SIG for review if it is beyond the technical reviewers scope.
11+
* LGTM blog posts once it is approved from a technical perspective.
12+
13+
## Skills and Experience Required
14+
15+
* Proficiency in technical terminology used within the Kubernetes project.
16+
* Strong written and verbal communication skills are required.
17+
* A working knowledge of GitHub.
18+
19+
## Activities
20+
21+
* Attending and participating in biweekly editorial meetings.
22+
* Providing a technical review on all blog posts.
23+
24+
## Time Commitments
25+
26+
The time commitment is typically 5-10 hours per quarter depending on the number of blog posts in the review queue.

0 commit comments

Comments
 (0)