Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contribex-comms blog shadow guide #7890

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

fsmunoz
Copy link
Contributor

@fsmunoz fsmunoz commented May 9, 2024

Initial version of the Contribex Comms blogging shadowing guide.

Fixes #7875

fsmunoz and others added 4 commits April 19, 2024 15:55
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 9, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fsmunoz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 9, 2024
@k8s-ci-robot k8s-ci-robot added area/community-management size/M Denotes a PR that changes 30-99 lines, ignoring generated files. area/contributor-comms Issues or PRs related to the upstream marketing team sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. labels May 9, 2024
@fsmunoz
Copy link
Contributor Author

fsmunoz commented May 9, 2024

/area contributor-comms
/sig contributor-experience

@kaslin
Copy link
Contributor

kaslin commented May 31, 2024

/lgtm
Would like to see at least one more lgtm before adding an approve label. @ArvindParekh? @chris-short? Other current Blogging Shadows? Would love to hear from current shadows if this content seems helpful to them.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 31, 2024
@kaslin
Copy link
Contributor

kaslin commented May 31, 2024

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 31, 2024
@kaslin
Copy link
Contributor

kaslin commented May 31, 2024

Added a hold because I realized it already has the approved label, since it was created by a lead with approver privileges. Soft requirement on the additional lgtm, but I think it would be good to have.

Copy link
Contributor

@ArvindParekh ArvindParekh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would love to hear from current shadows if this content seems helpful to them.

It does! I gave the article a read again as a new contributor and I found some areas that could benefit from a little more information. Would love to hear your thoughts about it.
Just a few suggestions, let me know if they're helpful or not, and I'd be happy to go ahead and add the additional lgtm @kaslin :)


* Knowledge of git and GitHub (issues, PRs, reviews, merges, etc)
* Knowledge of the existing blogging standards, including the ones
external to SIG Contribex Comms (like the SIG Docs standards)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
external to SIG Contribex Comms (like the SIG Docs standards)
external to SIG Contribex Comms (like the [SIG Docs standards](https://kubernetes.io/docs/contribute/style/style-guide/))

New contributors might not know about the existing blogging standards. Should we add a link here to the Documentation style guide?
Also, are there any other blogging standards that I'm not aware of?


In terms of time requirements, this is a very flexible programme since
writing articles is something that can be done asynchronously. The
following provides a minimal guideline:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably a nit, but should we mention that the mentioned time requirements are on a per week basis?

involvement:

* Write an interview script.
* Open an Issue and a PR.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While giving this a read, it sounded a bit unclear.

Suggested change
* Open an Issue and a PR.
* Open an Issue and a PR to publish the completed article.

Comment on lines +88 to +89
* Carry an article from inception to publication, updating the project
board and Slack channel.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First-timers could misinterpret this as updating the Slack channel in some way. I know we mean keeping the SIG informed about the progress on Slack, and it's probably a nit, but putting it out there to see if it's confusing to someone else too. If not, totally good to go 👍🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/community-management area/contributor-comms Issues or PRs related to the upstream marketing team cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

Add a shadowing guide for SIG Contribex blogging
5 participants