summaryrefslogtreecommitdiff
path: root/mentoring/programs
diff options
context:
space:
mode:
authorparispittman <parispittman@google.com>2020-02-05 00:16:30 -0800
committerparispittman <parispittman@google.com>2020-02-05 00:31:48 -0800
commit06dd9da30e05d1254e72fa7fdf2d89f135664e05 (patch)
treeb912b29fac359e32da56368b6810cd5fda63123a /mentoring/programs
parent6334fd8f4dbb369ec74803b55b26927b4a6234b9 (diff)
mentoring folder restructuring
Diffstat (limited to 'mentoring/programs')
-rw-r--r--mentoring/programs/google-summer-of-code.md62
-rw-r--r--mentoring/programs/group-mentee-guide.md88
-rw-r--r--mentoring/programs/group-mentoring.md84
-rw-r--r--mentoring/programs/mentoring-events.md11
-rw-r--r--mentoring/programs/outreachy.md45
-rw-r--r--mentoring/programs/shadow-roles.md9
-rw-r--r--mentoring/programs/the1-on-1hour.md30
7 files changed, 329 insertions, 0 deletions
diff --git a/mentoring/programs/google-summer-of-code.md b/mentoring/programs/google-summer-of-code.md
new file mode 100644
index 00000000..4a02902e
--- /dev/null
+++ b/mentoring/programs/google-summer-of-code.md
@@ -0,0 +1,62 @@
+# Google Summer of Code
+
+Kubernetes is happy to announce that we have participated in the Google Summer of Code (GSoC) program
+under the Cloud Native Computing Foundation (CNCF) in 2017, 2018, 2019 and as an independent organization
+in 2015. The details for the current year can be found [here](https://github.com/cncf/soc).
+
+Please see the [main program page](https://summerofcode.withgoogle.com/) for general information about the program,
+such as its purpose, timeline, eligibility requirements, and how to apply.
+
+## What is Kubernetes?
+
+Kubernetes is an open-source system for automating deployment, scaling, and management of containerized applications.
+It groups containers that make up an application into logical units for easy management and discovery.
+Kubernetes builds upon 15 years of experience of running production workloads at Google, combined with best-of-breed ideas and practices from the community.
+Please see [kubernetes.io](https://kubernetes.io/) for more details.
+
+## What are SIGs?
+
+Kubernetes is a set of projects, each shepherded by a special interest group (SIG).
+To get a grasp of the projects that we work on, check out the complete [list of SIGs](/sig-list.md).
+
+This [slide deck](https://docs.google.com/presentation/d/1JqcALpsg07eH665ZXQrIvOcin6SzzsIUjMRRVivrZMg) provides an overview of how the Kubernetes community is organized.
+
+## Communication
+
+- Mailing List: development announcements and discussions appear on the Google group `kubernetes-dev` (send mail to kubernetes-dev@googlegroups.com).
+- Slack: #gsoc-apps channel on the Kubernetes Slack. You can get an invite [here](http://slack.k8s.io/).
+
+## Contribute
+
+As part of the application process, the Google Summer of Code program recommends that candidates make small contributions to the project they intend to apply for.
+To start working on the project, make sure to fill out the [CLA](/CLA.md) and check if you have the right environment with this guide.
+The README in the [community repo](https://github.com/kubernetes/community) details these things and more.
+
+## Guides
+
+Google Summer of Code provides official guides for [students](https://google.github.io/gsocguides/student/) and [mentors](https://google.github.io/gsocguides/mentor/).
+
+Please read the guides and [FAQs](https://developers.google.com/open-source/gsoc/faq) to get an idea of what it means to participate in the program.
+
+## Coordination
+
+| **Name** | **Slack** | **Email** |
+|----------|-----------|-----------|
+| [Ihor Dvoretskyi](https://github.com/idvoretskyi) | @ihor.dvoretskyi | ihor@cncf.io |
+| [Nikhita Raghunath](https://github.com/nikhita) | @nikhita | nikitaraghunath@gmail.com |
+| [Paris Pittman](https://github.com/parispittman) | @paris | parispittman@google.com |
+
+The coordinators can be contacted at any time. The easiest way is to send a slack message.
+
+Do you have an idea for a task that is suitable for this program? Contact the mentors or coordinators!
+Or even better, volunteer for mentoring an intern during the work on your idea!
+
+## Past Participation
+
+Kubernetes has participated in Google Summer of Code in [2019](https://summerofcode.withgoogle.com/archive/2019/organizations/6034778267058176/), [2018](https://summerofcode.withgoogle.com/organizations/6453865516367872/) and [2017](https://summerofcode.withgoogle.com/archive/2017/organizations/6018829461225472/) as a part of CNCF and in [2015](https://www.google-melange.com/archive/gsoc/2015/orgs/kubernetes) as an independent organization.
+
+To get an idea about the projects, you can take a look at the list of project ideas published for GSoC [2017](https://github.com/cncf/soc/blob/master/2017.md#kubernetes), [2018](https://github.com/cncf/soc/blob/master/2018.md#kubernetes), and [2019](https://github.com/cncf/soc/blob/master/2019.md#kubernetes)
+
+## Code of Conduct
+
+Kubernetes abides by the [Code of Conduct](/code-of-conduct.md).
diff --git a/mentoring/programs/group-mentee-guide.md b/mentoring/programs/group-mentee-guide.md
new file mode 100644
index 00000000..c8ddab4a
--- /dev/null
+++ b/mentoring/programs/group-mentee-guide.md
@@ -0,0 +1,88 @@
+# Mentee Guide for Group Mentoring
+This doc is a work in progress
+
+## Welcome and Summary
+Welcome prospective mentee! This is an experimental group mentoring program
+where individuals will work self-paced in a semi-structured learning environment
+over the course of three months. Want to get lgtm rights? Be a decision maker in
+an OWNERS file? This could be a great way to get the knowledge you need, some
+accountability to do it, and interact with active contributors who may on the
+same path as you and our experienced Kubernetes developers.
+
+During the three month period, you will work on a path to the next level of
+membership which will take some work along with peers who have the same goal.
+This cohort will include mentors who are at least the level that you are
+targeting with ample experience in the project. These mentors will counsel but
+not provide answers to the problem or the solution itself. Think of them as true
+pilots of the sea - navigational experts - only to our codebase. At the end of
+the three month period, you'll have conversations with the mentors about getting
+into the OWNERs file.
+
+Familiarize yourself with the [community membership requirements doc]including
+the requirements needed for your specific journey. You’ll receive sponsorship
+from the mentors and other people you've worked on issues/PRs with upon
+successful completion of the program.
+
+## Expectations
+* You understand the requirements to become $member_role (ex: member->reviewer)
+* Good standing throughout the program and uphold our code of conduct
+* Check-in during a designated day on slack for a "stand-up". Mentors will be
+there that day, too, and guaranteed feedback.
+* Be helpful to your peers in the cohort
+* Give back and be a mentor in a future cohort
+* Mutual respect from mentors and peers who are in the cohort with you
+
+### Member to Reviewer Cohort
+Topics that are good for discussion during that time period:
+* Code Reviews the Kubernetes Way (i.e. best practices)
+* How to groom issues for new members/contributors
+* Communicating effectively (on GH and throughout project)
+* Technical documentation
+* Kubernetes Governance 201 (SIG deep dive, proposals)
+* Testing (what should be an e2e test, how to write S, M, L, tests)
+* Kubernetes Governance 101 (keps, subprojects, OWNERS files, steering committee,
+etc.)
+* Identifying & understanding issue backlog and prioritization
+* Contributing to testing (how to run tests and create new ones)
+
+Suggested Activity
+* Be a tech reviewer for docs
+* Write an E2E test
+* Help out in #pr-reviews
+
+### Current Approver Cohort
+* Communicating effectively as a leader (on GH and throughout project)
+* How to write better docs (release notes, etc.)
+* How to propose a new feature (features, design proposals)
+TODO: add more here
+
+### Other Help Resources
+- slack
+ - #kubernetes-dev
+ - your respective sig or other sigs that could help
+ - [SIG List]
+ - #sig-contribex
+ - #meet-our-contributors
+ - #pr-reviews
+- mailing lists
+ - kubernetes-dev@googlegroups.com
+ - your respective sig (ie - kubernetes-sig-cli@googlegroups.com)
+- contributor office hours
+ - Kubernetes Community Office Hours
+ - #office-hours on slack
+- the docs
+ - kubernetes/community is your friend for upstream workflows, processes, and
+ information around contributing
+ - This repo includes the community/contributors/devel folder which will be
+ extra helpful that includes docs such as:
+ - [Code Review Expectations]
+ - [Collaboration on k8s]
+
+Thank you to both mentees and mentors for taking on this new, unchartered
+territory! We will be building documentation around you and appreciate your
+guidance as a founding member of this program!
+
+[community membership requirements doc]: /community-membership.md
+[SIG List]: /sig-list.md
+[Code Review Expectations]: /contributors/guide/expectations.md
+[Collaboration on k8s]: /contributors/guide/collab.md
diff --git a/mentoring/programs/group-mentoring.md b/mentoring/programs/group-mentoring.md
new file mode 100644
index 00000000..7ee1c616
--- /dev/null
+++ b/mentoring/programs/group-mentoring.md
@@ -0,0 +1,84 @@
+# Group Mentoring for Contributor Ladder Growth
+*This is a work in progress*
+
+
+## Summary
+This is an experimental group mentoring program where individuals will work
+self-paced in a semi-structured learning environment over the course of three
+months. Want to get `/lgtm` rights? Be a decision maker in an OWNERS file? This
+could be a great way to get the knowledge you need, and some accountability to
+do it. Through this program you will get the opportunity to interact with active
+contributors who may be on the same path as you as well very experienced
+Kubernetes contributors.
+
+## How This Works
+Foundation:
+This program is built around our [community membership guidelines].
+This doc shows how you can grow through the project in different roles and
+provides the requirements to get to each level on our ladder. Building trust is
+the key to this document.
+
+## Cohorts
+Contributors will form small cohorts of no more than 10 (8-10 is great) all aiming
+to achieve the same goal - the next stage on the contributor ladder - with the
+help of active contributors (1 mentor to 3 mentees). For example, our first test
+cohort was Member -> Reviewer in SIG Apps, SIG Cluster Lifecycle, and SIG AWS.
+
+Each cohort will last 2-3 months based on the time requirement in the community
+membership guidelines per level. This time requirement is pretty flexible and not
+a hard line because as noted above, this is about building trust and skills. Folks
+want to know you are dependable and understand the domain.
+
+The cohort gathers on slack in a private room that one of the mentors or sig-contribex
+will PR into the slack config files on the k/community repo.
+TODO: make the self service aspect here solid for faster onboarding
+
+Mentors can rotate facilitating once a week for slack standups with the expectation
+that cohort members need to check in with a predetermined status update
+(accomplishments, challenges, etc)
+
+## Benefits of a Cohort
+* Peer mentoring
+* Clear goals, objectives, and timelines
+* Each mentee is working toward the same goal, cohort has an end date/timeframe
+* Exposure to multiple areas of the project making well-rounded contributors
+* Mentors share time commitments and responsibilities
+* Exposure to multiple mentors in an open and collaborative environment
+
+
+## Mentor requirements
+TODO
+
+## First Cohort Success Rates
+5/10 graduated into OWNERs files from members to reviewers.
+TODO check how many are still active
+
+## FAQs
+I'm a SIG Chair/TL/Subproject Owner and have a need for more members, reviewers,
+approvers, how can we form a cohort?
+TODO
+
+I'm a contributor looking for a cohort, where do I go?
+TODO
+
+I'm not a chair, tech lead, or subproject owner but I'm a reviewer or approver,
+how can I help?
+TODO
+
+
+## Important Links
+[Mentor Guide]
+[Mentee Guide]
+
+
+## Open ended questions
+how can mentors organize the tasks, issues, prs, that they give to the mentees?
+should they be high priority items to help with backlog and mentor at the same time?
+should we include a list of topics that should be covered by role?
+- example: for member to reviewer we focused on - live how to code review, how to review [better] docs, communicating with empathy, advanced testing/ci, general community/governance
+
+
+[Mentee Guide]: /mentoring/group-mentee-guide.md
+[Mentoring/Contributor Info Form]: https://goo.gl/forms/SHWAiZ9Ih1qwuJbs1
+[Mentor Guide]: /mentoring/mentor-guide.md
+[community membership guidelines]: /community-membership.md
diff --git a/mentoring/programs/mentoring-events.md b/mentoring/programs/mentoring-events.md
new file mode 100644
index 00000000..cd3fa7f3
--- /dev/null
+++ b/mentoring/programs/mentoring-events.md
@@ -0,0 +1,11 @@
+# Mentoring Activities at Events
+
+During events like KubeCon and other related events that arise, there will be the opportunity for mentoring activities. This doc will list those. The KubeCon events are run by CNCF/LF and not Contributor Experience although we may advise and members could help out.
+
+## Pod Mentoring
+
+Pod mentoring gathers a group of mentors to help you get your Kubernetes-related questions answered quickly and efficiently. More mentors means more breadth of knowledge and experience, resulting in a better chance of at least one person being able to answer your question. It can also mean multiple perspectives since there isn't always one right answer!
+
+To be respectul of each mentors time, please have succinct questions ready and a brief summary of what you've tried and what you'd like or expect to happen. For instance, an example of a poor question would be, "How do I write a controller?" An example of a good question would be, "I'd like to create a custom controller that checks for nodes that are in the 'Not Ready' state and print our their IP address. I'm not familiar with Golang so instead of using client-go I've looked at MetaController as a way to get started using Javascript. I'm having trouble with this portion of the webhook, can you please take a look?"
+
+Pod mentoring will be available during KubeCon + CloudNativeCon events. You will need to register to attend to be eligible for mentoring. For those who wish to be a mentor please take a look at the [mentor-guide](mentor-guide.md).
diff --git a/mentoring/programs/outreachy.md b/mentoring/programs/outreachy.md
new file mode 100644
index 00000000..be4d86fd
--- /dev/null
+++ b/mentoring/programs/outreachy.md
@@ -0,0 +1,45 @@
+# Outreachy
+
+Kubernetes is happy to announce our participation in the Outreachy program. Please see the [main program page](https://www.outreachy.org/) for general information including the time line for semesters as it's only a few times a year. The outreachy site also provides the eligibility requirements and how to apply.
+
+If we are currently participating, you will see the Kubernetes project listed [here](https://www.outreachy.org/apply/project-selection/#kubernetes). If you are interested in becoming a mentor or have a Kubernetes project that would be good for an Outreachy intern, please reach out to #sig-contribex on slack.
+
+## What is Kubernetes?
+
+Kubernetes is an open-source system for automating deployment, scaling, and management of containerized applications.
+It groups containers that make up an application into logical units for easy management and discovery. Kubernetes builds upon 15 years of experience of running production workloads at Google, combined with best-of-breed ideas and practices from the community.
+Please see [kubernetes.io](https://kubernetes.io/) for more details.
+
+## What are SIGs?
+
+Kubernetes is a set of projects, each shepherded by a special interest group (SIG).
+To get a grasp of the projects that we work on, check out the complete [list of SIGs](/sig-list.md).
+
+This [slide deck](https://docs.google.com/presentation/d/1JqcALpsg07eH665ZXQrIvOcin6SzzsIUjMRRVivrZMg) provides an overview of how the Kubernetes community is organized.
+
+## Communication
+
+- Mailing List: development announcements and discussions appear on the [`kubernetes-dev`](https://groups.google.com/forum/#!forum/kubernetes-dev) Google Group.
+- Slack: Please [sign up](http://slack.k8s.io/) for an invite and join the the [#outreachy-apps](https://kubernetes.slack.com/messages/outreachy-apps) channel.
+
+## Contribute
+
+As part of the application process, the Outreachy program recommends that candidates make small contributions to the project they intend to apply for.
+
+To start working on the project, make sure to fill out the [CLA](/CLA.md) and check if you have the right environment with this guide.
+The README in the [community repo](https://github.com/kubernetes/community) details these things and more.
+
+## Coordination
+
+| **Name** | **Slack** | **Email** |
+|----------|-----------|-----------|
+| [Paris Pittman](https://github.com/parispittman) | @paris | parispittman@google.com |
+| [Nikhita Raghunath](https://github.com/nikhita) | @nikhita | nikitaraghunath@gmail.com |
+
+The coordinators can be contacted at any time. The easiest way is to send a slack message.
+
+Do you have an idea for a task that is suitable for this program? Contact the mentors or coordinators! Or even better, volunteer for mentoring an intern during the work on your idea!
+
+## Code of Conduct
+
+Kubernetes abides by the [Code of Conduct](/code-of-conduct.md).
diff --git a/mentoring/programs/shadow-roles.md b/mentoring/programs/shadow-roles.md
new file mode 100644
index 00000000..62f95aef
--- /dev/null
+++ b/mentoring/programs/shadow-roles.md
@@ -0,0 +1,9 @@
+future home of a doc that lists all of the shadow programs we have and how to get involved
+
+example teams:
+release
+api review
+contributor summit planning
+contributor/community repo triage
+upstream marketing
+sig-docs-blog
diff --git a/mentoring/programs/the1-on-1hour.md b/mentoring/programs/the1-on-1hour.md
new file mode 100644
index 00000000..f748782b
--- /dev/null
+++ b/mentoring/programs/the1-on-1hour.md
@@ -0,0 +1,30 @@
+The 1:1 Hour
+=======
+//this is a work in progress. Please follow along to our issues in
+kubernetes/community with the tag `area/mentorship-planning`
+
+
+One mentor. One mentee. One Hour.
+
+In this mentorship opportunity, you'll be paired with someone in the ecosystem that can help drive your upstream Kubernetes experience forward with a quick burst of information. The mentee controls the content that will be served during that hour. This is open for new AND current contributors of all [levels](/community-membership.md).
+
+Activities that you can select from include:
+* pair programming
+* live code review how-to (for those wishing to be a reviewer or be a better reviewer)
+* live docs review how-to
+* live code review of a proposed solution you are working on
+* codebase tour of a certain area
+* guidance on your contributor path (advice on becoming an approver, etc.)
+* AMA session (ask anything!)
+
+We will attempt to match you with the closest mentor of your area of interested or activity.
+
+## Sign up!
+[Fill out this form](https://goo.gl/forms/9WllkPFTRB999vcc2) and we'll be in touch!
+
+## Mentors
+
+If you are interested in signing up to be a mentor for this, please see the [mentor guidelines](mentor-guide.md).
+
+### Notes
+Please pardon our dust as we build out the process for this and recruit more mentors.