|
| 1 | +## SIG Spotlight articles |
| 2 | + |
1 | 3 | The contributor comms team has an ongoing effort to create blog posts which shine a spotlight on various Special Interest Groups (SIGs) of the Kubernetes project. The goal of these posts is to draw attention to the wonderful work each SIG is doing, and to amplify the needs of these SIGs, hopefully encouraging new or existing contributors to join in on the SIG's efforts. Writing a SIG Spotlight blog post is an excellent task for new contributors, who will learn about other parts of the Kubernetes project while making a visible, meaningful contribution.
|
2 | 4 |
|
3 |
| -The steps to create a SIG Spotlight blog post are as follows: |
4 | 5 |
|
5 |
| -1) Choose a sig (Not Windows, Multicluster, or Docs) |
6 |
| -2) Join that SIG’s channel in Slack and say something along the lines of “Hello! I’m a member of the contributor comms team of SIG-ContribEx and I’m interested in writing a blog spotlighting your SIG. Who should I interview for this feature?” |
7 |
| -3) Interview those people - usually the SIG chairs. We generally recommend doing the interview asynchronously via a Google Doc because written responses are easier to work with. The SIG-Multicluster one was done with a recorded zoom interview but it took a long time to complete. |
8 |
| -4) Write a blog post. The post should be in markdown format and we like to do a round of review on a rough draft before creating a PR. We recommend either hackmd.io or Google Docs for this. Google Docs can be converted to markdown fairly easily. |
| 6 | +1. Approach the SIG in their general Slack channel, presenting yourself and asking for their help |
| 7 | + * something along the lines of _"Hello, I'm working in contribex-comms in our SIG Spotlight series and would love to write a blog spotlighting your SIG. It's not time-consuming and will be published, providing added visibility and focus on things important for the SIG. Who should I interview?"_ is perfectly fine, but feel free to work around the main idea and add your own words. |
| 8 | + * You can mention (@) the co-chairs of the SIG in your initial message, or in an additional reply to the thread in case there is no feedback. |
| 9 | +2. If prompted for more details or as a reply to someone asking "what's next", provide some examples of published SIG Spotlight articles, and describe the process in simple terms. |
| 10 | + * A summary of the process could be _"I'll write some initial questions and share them with you; based on your answers and eventual suggestions of additional topics to cover we will finish the interview, and from then on we will take care of the publishing process"_. |
| 11 | +4. The interview process can be done in different ways, the following are some suggestions: |
| 12 | + * Create a Google Docs file with some initial questions, and ask them to write answers, and suggest additional topics if needed; we generally recommend doing the interview asynchronously via a Google Doc because written responses are easier to work with. The SIG-Multicluster one was done with a recorded zoom interview but it took a long time to complete. |
| 13 | + * We have [example topics](example-topics.md) available for you to use, plus the existing articles that serve as a reference. |
| 14 | + * You can either write some initial questions, get answers, and stop there, or based on the answers add new ones. |
| 15 | + * Consider that you're not bound by your initial questions: it's very common for an answer to cover things that would be even better as a reply to a question that isn't there. You can add that questions and refactor answers to improve the flow, as long as the final version is reviewed and approved by the SIG person being interviewed. |
| 16 | +5. With that final version, create a markdown file in hackmd.io, based on the blog markdown template, and share it with the Contribex Comms Blogging lead and the community (the `#sig-contribex-comms` channel). |
| 17 | + * We will do a preliminary round of reviews on this, which is why it's better to have in outside of github at this stage, and before creating the PR. |
| 18 | + * If you don't want to use hack.md, the original Google Docs file can also be used. |
| 19 | + |
| 20 | + |
| 21 | +The Blogging Lead will assist in assigning an Editor and tracking it, and the Contribex Comms blogging team will open up the PR (as per the blogging guidelines). |
| 22 | + |
| 23 | +### Resources: |
9 | 24 |
|
10 |
| -[Past Spotlights](./sig-spotlights.md) |
| 25 | +* List of [Past Spotlights](./sig-spotlights.md) |
| 26 | +* [Blogging guidelines](./blog-guidelines.md) |
| 27 | +* [Example topics for Spotlight interviews](./example-topics.md) |
0 commit comments