From 32d98f5df56e765b8babcb3f33eea90f0b3a5383 Mon Sep 17 00:00:00 2001 From: Kendall Nelson Date: Fri, 19 Oct 2018 15:44:28 -0700 Subject: [PATCH] Specifically call out Non-Code Contribution Its not the most clear to people looking at the guide that there are other ways to contribute other than code. There are sections on being an operator and a user, but there are other types of non code contribution than those. This is the first step in enumerating these other types of contribution. This patch also adds a section on mentoring to the common directory. In the future, it might be good to add it to the indices for other sections of the guide- code& docs, operators, etc- in a follow up patch but at this point the focus is populating the non-code contribution activities list. Story: 2001437 Task: 6148 Story: 2004131 Task: 27577 Change-Id: I7b64ea62572749c0fe097766d12d5655df79b7c0 --- doc/source/common/mentoring.rst | 84 ++++++++++++++++++++++ doc/source/index.rst | 1 + doc/source/non-code-contribution/index.rst | 67 +++++++++++++++++ 3 files changed, 152 insertions(+) create mode 100644 doc/source/common/mentoring.rst create mode 100644 doc/source/non-code-contribution/index.rst diff --git a/doc/source/common/mentoring.rst b/doc/source/common/mentoring.rst new file mode 100644 index 0000000..b807052 --- /dev/null +++ b/doc/source/common/mentoring.rst @@ -0,0 +1,84 @@ +.. _mentoring: + +######### +Mentoring +######### + +The Cohorts +=========== + +As it stands right now, there are 4 mentoring cohorts: + +* Get your first patch merged: Mentors will assist mentees with crafting + a change, understanding and adhering to the Developers Guide, submitting + to Gerrit, responding to reviews, and ultimately having their change + accepted. +* First CFP submission or Give your first talk: Mentors will assist mentees + with submitting a CFP and preparing to give a talk. This could be + for OpenStack Summit, OpenStack Days, a local meetup, or another conference + or event. +* Deploy your first Cloud: Mentors will provide assistance to mentees + deploying OpenStack for the first time. This could involve analysis of + available deployment tools, configuration, or troubleshooting. +* Become COA certified or study for COA: Mentors will provide support and + guidance to mentees as they prepare for the COA exam. + +If there is a topic you are interested in mentoring someone in, or being +mentored in, the organizers are always looking for new ideas! Please fill +out the form below that corresponds to your roll and let them know! + +Participating as a Mentor +========================= + +The first thing you'll want to do is sign up using this `mentor form +`_. +This will get you into our spreadsheet of mentors so that we can keep track +of who is working with which group so when we need to help bolster certain +cohorts with calls for mentors, we can see who is already involved. + +Participating as a Mentee +========================= + +Similar to being a mentor, the first thing you'll want to do is sign +up using this `mentee form `_. +This will help us know who is participating and what their goals are. + +Join the Mailing List & IRC Channel +=================================== + +.. note:: + + This section assumes you have completed the :doc: '/common/irc' section + of the contributor guide. It might also be helpful to cover the more + generic information about mailing lists in the Communication + page's :ref:`communication-mailing-lists` section as well. + +Mentoring Mailing List +---------------------- + +The mailing list is where most day to day asynchronous interactions happen. +Here is where you can get `subscribed and view ML archives `_. + +When sending emails to the ML, if your subject is specific to one cohort, +please use the relevant tag: + +* [first-patch] for getting your first patch merged +* [first-cfp] for giving your first conference talk +* [first-cloud] for deploying your first cloud +* [coa] for becoming a Certified OpenStack Administrator + +**Both mentors and mentees should subscribe to stay up to date with +conversations.** + +#openstack-mentoring +-------------------- + +On IRC, we also have a dedicated channel for the topics our cohorts focus on. +Please join #openstack-mentoring whenever you are online to stay in the loop +and meet other people that have overlapping timezones- both mentors and +mentees. + +General Information +------------------- + +The cohort program is hosted under the `Diversity and Inclusion Working Group `_. For more information about the cohort program, you can check out their `wiki `_. diff --git a/doc/source/index.rst b/doc/source/index.rst index 7b1e30d..80d2327 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,6 +12,7 @@ The OpenStack Contributor Guide common/introduction code-and-documentation/index + non-code-contribution/index users/index operators/index contributing/index diff --git a/doc/source/non-code-contribution/index.rst b/doc/source/non-code-contribution/index.rst new file mode 100644 index 0000000..e1085de --- /dev/null +++ b/doc/source/non-code-contribution/index.rst @@ -0,0 +1,67 @@ +########################## +Non-Code Contributor Guide +########################## + +As with all Open Source communities, there are more ways to contribute than to +push code. If you're interested in doing that, great! You'll want to start over +here with the :doc:`../code-and-documentation/introduction` guide instead. If +not, you've come to the right place! + +First, we would like to say welcome to our community! We may look big and +confusing at the start, but we promise that we are here to help you find your +place and answer your questions. + +Depending on what you're interested in and the level of involvement you would +like to have, we have something for you! In the following sections of this +guide, we will cover all the different ways of contributing that don't deal +with writing code. + +Getting to Know the Community +============================= + +These sections of the guide will help you get to know our community's +structure - how we organize ourselves, how we organize the work we do +along a timeline, and what events we have to help us get things done. + + +* :doc:`../common/events` are essential to our community health and + development process. While we as contributors span the globe, we + occasionally get together to make progress face to face. + +* :doc:`../common/governance` is not always the most thrilling + topic, but its important to understand how we organize ourselves to + help get the work done efficiently. + +* :doc:`../common/releases` and understanding the process that + the different OpenStack components go through gives context to how + we work as a community. + +Communicating with the Community +================================ + +These sections of the guide help you set up the tools you might need +to communicate with different parts of the community. + +* :doc:`../common/irc` (Internet Relay Chat) is our synchronous way of + communicating. + +* :doc:`../common/accounts` are important for a variety of + activies such as participating in elections, filing bugs in our + community task trackers, and submitting speaker presentations. + +* :doc:`../common/communication` is the most important thing + we can teach you in this guide. Without our mailing lists, IRC, and + other community tools, we would not be able to collaborate across + the globe to build the amazing software that we do. + +Non-Code Contribution Types +=========================== + +* :doc:`../common/mentoring` in the OpenStack community is set up + to be a light weight cohort style program where each cohort focuses + on accomplishing a specific goal. + +.. toctree:: + :hidden: + + /common/mentoring