search

theopensourceway / guidebook

Guidebook of open source community management best practices; is somewhat opinionated.
Other
168 stars 41 forks source link

New outline for the onboarding chapter #176

Closed rpaik closed 3 years ago

rpaik commented 3 years ago

@semioticrobotic, @quaid, @palante this is still in draft/outline stage.

rpaik commented 3 years ago

Should be ready for the first review.

@palante I have a placeholder section for "mentorship". Please feel free to rename the section and/or move it to a different spot in the chapter.

rpaik commented 3 years ago

@semioticrobotic appreciate your review and edits. Like all your suggestions 😄

semioticrobotic commented 3 years ago

Thanks, @rpaik. Hoping to add a bit more over the next few days.

semioticrobotic commented 3 years ago

You're correct, @rpaik. The material will need to be edited for tone, voice, consistency, etc. Slowly working my way there. :smile:

palante commented 3 years ago

Thanks @rpaik @semioticrobotic !

Good to know about 3rd person -- originally put back existing content and helpful to know going forward!

It looks like I don't have write access so I think that's why unable to commit directly the branch and had to make the PR 😬 (thanks for merging that in). Maybe as an experiment, @rpaik are you able to commit to directly to this existing PR by @quaid ? (https://github.com/theopensourceway/guidebook/pull/180)

If so, would be great to see how you did it! I tried a few things but the non write access seemed to prevent.

And also, there's one more PR for additional mentorship content, thanks!

https://github.com/rpaik/guidebook/pull/2

rpaik commented 3 years ago

@semioticrobotic & @quaid I'm still getting familar with GitHub after a few years at GitLab, but it looks like only maintainers can make direct edits to a branch?

Not sure if there's a way to streamline the process with multiple authors?

rpaik commented 3 years ago

@semioticrobotic @palante, I actually discussed this with @quaid and others during this week's stand-up meeting...

I think it makes sense for mentorship to have its own chapter. Even before the latest PR👆 from @palante, there's a lot of content on mentorship and it doesn't seem right for the topic to be buried under the "onboarding" chapter. I do mention mentors in the onboarding resources section and I can add a mention of the mentorship chapter as a cross-reference.

If you're OK with this, I think the next steps can be:

  1. @rpaik to remove the mentorship section from this chapter.
  2. @palante can open a new PR (with a new branch from master) to start a new chapter on mentorship using the contents that he already has👆

WDYT?

semioticrobotic commented 3 years ago

Certainly fine by me, @rpaik, but I defer to @palante's decision, as the person most interested in authoring that material.

palante commented 3 years ago

Sounds good on my end as well! 😄

Tonight, I can make a new PR that has the new mentorship content and the existing mentorship content. I'll add you both (@rpaik and @semioticrobotic ) and @quaid as reviewers as well (eg edits, improvements, etc).

Thanks all!

rpaik commented 3 years ago

Thanks, both for a quick response 💯

I think this will also help alleviate the problem that we encountered when multiple "non-maintainers" (who don't have edit rights to branches) are collaborating on a chapter 😆

quaid commented 3 years ago

This is good stuff, folks, thanks. I am assigning issue #159 to @palante, which is from my proposed chapter titled of "Creating a Culture of Mentorship". This goes in the "Growing Contributors" section.

@palante It's OK if the title ends up changing or morph. We don't have a file for it in the repo yet, you can include creating it as part of the pull request. The format should follow creating_a_culture_of_mentorship.adoc. You can get the standard header from some of the other files, the template is like this:

= Chapter Name // Authors: Authoor Name email@example.com // Updated: YYYY-MM-DD // Versions: 2.0 // Status: DRAFT

palante commented 3 years ago

Thanks all, created new PR: https://github.com/theopensourceway/guidebook/pull/182

quaid commented 3 years ago

@rpaik @semioticrobotic I'd like to land this branch soon, primarily so I can get copyedit help from folks without having them use the PR review process. When you get to a natural point, let's land the branch for the development edit. Then we can see if more content is needed, or if it's ready to prepare and send for copyedit.

rpaik commented 3 years ago

@quaid thanks for your review 😃

I made some minor edits mostly to fix typos, but yes please feel free to merge this!