|
| 1 | +# Contributor Comms Blogging: Shadow Guide |
| 2 | + |
| 3 | +Contribex Comms has leads for different areas, specifically for |
| 4 | +blogging where there's a Blogging Lead that takes additional |
| 5 | +responsibility for making sure that the blogging process not only |
| 6 | +works as expected, but is constantly being improved to better serve the |
| 7 | +goals in the [SIG charter](./CHARTER.md). |
| 8 | + |
| 9 | +Roles in SIG Contribex Comms are part of a journey where each |
| 10 | +individual learns and teaches, improves on what exists and eventually |
| 11 | +moves forward to other challenges; for this to work, it's fundamental |
| 12 | +to develop leadership skills in the community, and one way of doing it is |
| 13 | +through a shadow program. |
| 14 | + |
| 15 | +This document briefly describes the shadowing program, including the |
| 16 | +tasks that are expected from shadows. It is hoped that this extra |
| 17 | +level of detail helps shadows in their path towards additional |
| 18 | +responsibilities in the team. |
| 19 | + |
| 20 | + |
| 21 | +## Shadow Program Goals |
| 22 | + |
| 23 | +It's important to highlight that anyone is welcome to contribute with |
| 24 | +ideas and write articles _without being a shadow_, and the shadowing |
| 25 | +program is not meant to change that, but to enable it by guaranteeing |
| 26 | +that there's the availability to assist contributors that want to |
| 27 | +participate; writing and publishing articles requires a mix of |
| 28 | +technical and non-technical knowledge that shouldn't be an obstacle |
| 29 | +for participation. The Blogging Lead helps with that, and the |
| 30 | +shadowing program is meant to: |
| 31 | + |
| 32 | +* Open up additional venues for participation for those in the community. |
| 33 | +* Provide a more structured way for anyone interested in the blogging |
| 34 | + side of things to learn by doing. |
| 35 | +* Maintain a pipeline of potential Blogging Leads. |
| 36 | + |
| 37 | +## Shadowing candidates |
| 38 | + |
| 39 | +Anyone is welcome to display their interest in becoming a shadow for |
| 40 | +the blogging team. For practical purposes, the team is limited to 4 |
| 41 | +shadows to allow an adequate exposure to the tasks in a reasonable |
| 42 | +period of time. |
| 43 | + |
| 44 | +Anyone interested in being a shadow should indicate that desire to the |
| 45 | +Blogging Lead, who will help in making sure that the candidate is |
| 46 | +aware of the expected commitment. The main requirement for shadowing |
| 47 | +is a willingness to participate actively and consistently. |
| 48 | + |
| 49 | +While not requirements, the following are things that will be a part |
| 50 | +of the work expected from shadows, so any existing mastery of them is |
| 51 | +certainly a plus: |
| 52 | + |
| 53 | +* Knowledge of git and GitHub (issues, PRs, reviews, merges, etc) |
| 54 | +* Knowledge of the existing blogging standards, including the ones |
| 55 | + external to SIG Contribex Comms (like the [SIG Docs standards](https://kubernetes.io/docs/contribute/style/style-guide/)) |
| 56 | +* Participation in the weekly SIG Contribex Comms meetings |
| 57 | + |
| 58 | +In terms of time requirements, this is a very flexible programme since |
| 59 | +writing articles is something that can be done asynchronously. The |
| 60 | +following provides a minimal guideline: |
| 61 | + |
| 62 | +* 1h for weekly participation in the SIG Contribex Comms meeting |
| 63 | +* 2h per week for working on the interviews and articles (reviewing, |
| 64 | + writing, etc). |
| 65 | + |
| 66 | + |
| 67 | +## Shadowing Program |
| 68 | + |
| 69 | +The first stage is mostly about helping and getting to know the |
| 70 | +process, and it includes: |
| 71 | + |
| 72 | +* Assist in reviewing an article: the shadow will review an article |
| 73 | + and provide suggestions to improve it. |
| 74 | +* Assist in writing an interview: the shadow will suggest questions |
| 75 | + and improvements to an existing interview script. |
| 76 | +* Assist in a GitHub PR review: the shadow will partipate in a GitHub |
| 77 | + discussion during the publishing process. |
| 78 | +* Help contributors: the shadow will reply to contributors in the team |
| 79 | + Slack channel, steering them in the right direction. |
| 80 | +* Propose a new topic: the shadow will identify new interesting |
| 81 | + articles and add them to the project board. |
| 82 | + |
| 83 | +The following stage includes tasks that require more direct |
| 84 | +involvement: |
| 85 | + |
| 86 | +* Write an interview script. |
| 87 | +* Open an Issue and a PR to publish the completed article. |
| 88 | +* Carry an article from inception to publication, updating the project |
| 89 | + board and providing updates in the Slack channel throughout the |
| 90 | + article lifecycle. |
| 91 | +* Provide feedback during weekly meetings. |
| 92 | + |
| 93 | +This is not an exhaustive list, but it serves as an indicator of what |
| 94 | +a shadow will be exposed to, and what will they be expected to do. |
0 commit comments