diff options
Diffstat (limited to 'mentoring/programs/contributor-workshop')
27 files changed, 934 insertions, 0 deletions
diff --git a/mentoring/programs/contributor-workshop/OWNERS b/mentoring/programs/contributor-workshop/OWNERS new file mode 100644 index 00000000..0c10d897 --- /dev/null +++ b/mentoring/programs/contributor-workshop/OWNERS @@ -0,0 +1,17 @@ +reviewers: + - alisondy + - guineveresaenger + - jberkus + - jeefy + - tpepper + +approvers: + - alisondy + - guineveresaenger + - jberkus + - jeefy + - tpepper + +labels: + - area/mentorship-planning + - sig/contributor-experience
\ No newline at end of file diff --git a/mentoring/programs/contributor-workshop/README.md b/mentoring/programs/contributor-workshop/README.md new file mode 100644 index 00000000..79941250 --- /dev/null +++ b/mentoring/programs/contributor-workshop/README.md @@ -0,0 +1,31 @@ +# Contributor Workshop + +## Overview + +The Contributor Workshop is a self paced course on the contributor site, aimed at both new and existing contributors. + +Previously this workshop was run as a live in person session, as part of the Kubernetes Contributor Summit. With many changes brought upon in 2020, we decided to change the format to a self paced course. + +## Status + +The Contributor Workshop is currently in development, and has not been released to the public. + +You can view the live state of the site by going to [https://workshop--kubernetes-contributor.netlify.app/docs/workshop/](https://workshop--kubernetes-contributor.netlify.app/docs/workshop/) + +The umbrella issue tracking getting this initiative available to the public is [kubernetes/community#4830](https://github.com/kubernetes/community/issues/4830). + +## Getting Involved + +* Read the guides on [Contributing to the Contributor Workshop](guides/README.md) + +* Attend the bi-weekly mentoring meeting + +* Join the discussion in #contributor-workshop-dev on Kubernetes Slack + +## Other Resources + +[live-workshop](live-workshop/README.md) - Resources for running a live contributor workshop + +## Previous Live Workshops + +* [2019 NA Contributor Summit NCW](https://www.youtube.com/watch?v=uUJrGwAom-E&list=PL69nYSiGNLP0OWp38tPBc-jSlMmwWr6Ci&index=16) (Videos in playlist, links to first NCW video) diff --git a/mentoring/programs/contributor-workshop/guides/README.md b/mentoring/programs/contributor-workshop/guides/README.md new file mode 100644 index 00000000..7280f8ac --- /dev/null +++ b/mentoring/programs/contributor-workshop/guides/README.md @@ -0,0 +1,41 @@ +# Contributing to the Contributor Workshop + +## Overview + +This folder contains guides and information on how to contribute to the Contributor Workshop. + +## Workshop Structure + +The workshop is divided into segments. These segments exist as individual pages in the ``content/en/docs/workshop`` directory on the branch ``workshop`` in the ``contributor-site`` repo. + +Each of these segments contain: + +* Written information +* One or more Exercises + +and may contain a video version of the written information. + +## Guides + +### [Updating & Creating Segments](updating-segment.md) + +How to update and create segments on the contributor site + +### [Video Recording Guide for Contributor Workshop Segments](videoguide.md) + +How to structure, record, upload and update video guides associated with workshop segments. + +## Glossary of Terms + +### Segment + +A page in the workshop directory covering a particular section of the Contributor Workshop. +This page may contain + +* Written information +* Video version of the segment +* Hands on exercise + +### Exercise + +A step by step, hands on activity within a segment. diff --git a/mentoring/programs/contributor-workshop/guides/obssettings.png b/mentoring/programs/contributor-workshop/guides/obssettings.png Binary files differnew file mode 100644 index 00000000..b8946ccd --- /dev/null +++ b/mentoring/programs/contributor-workshop/guides/obssettings.png diff --git a/mentoring/programs/contributor-workshop/guides/presenterexitfullscreen.png b/mentoring/programs/contributor-workshop/guides/presenterexitfullscreen.png Binary files differnew file mode 100644 index 00000000..0752c73f --- /dev/null +++ b/mentoring/programs/contributor-workshop/guides/presenterexitfullscreen.png diff --git a/mentoring/programs/contributor-workshop/guides/presenterfullscreen.png b/mentoring/programs/contributor-workshop/guides/presenterfullscreen.png Binary files differnew file mode 100644 index 00000000..8a6b81cb --- /dev/null +++ b/mentoring/programs/contributor-workshop/guides/presenterfullscreen.png diff --git a/mentoring/programs/contributor-workshop/guides/presenterview.png b/mentoring/programs/contributor-workshop/guides/presenterview.png Binary files differnew file mode 100644 index 00000000..252c25df --- /dev/null +++ b/mentoring/programs/contributor-workshop/guides/presenterview.png diff --git a/mentoring/programs/contributor-workshop/guides/presenterviewandslides.png b/mentoring/programs/contributor-workshop/guides/presenterviewandslides.png Binary files differnew file mode 100644 index 00000000..f3e88d60 --- /dev/null +++ b/mentoring/programs/contributor-workshop/guides/presenterviewandslides.png diff --git a/mentoring/programs/contributor-workshop/guides/presenterwindowed.png b/mentoring/programs/contributor-workshop/guides/presenterwindowed.png Binary files differnew file mode 100644 index 00000000..653d76ce --- /dev/null +++ b/mentoring/programs/contributor-workshop/guides/presenterwindowed.png diff --git a/mentoring/programs/contributor-workshop/guides/slidesnotabs.png b/mentoring/programs/contributor-workshop/guides/slidesnotabs.png Binary files differnew file mode 100644 index 00000000..1b41c84b --- /dev/null +++ b/mentoring/programs/contributor-workshop/guides/slidesnotabs.png diff --git a/mentoring/programs/contributor-workshop/guides/slideswithtabs.png b/mentoring/programs/contributor-workshop/guides/slideswithtabs.png Binary files differnew file mode 100644 index 00000000..e82882a2 --- /dev/null +++ b/mentoring/programs/contributor-workshop/guides/slideswithtabs.png diff --git a/mentoring/programs/contributor-workshop/guides/updating-segment.md b/mentoring/programs/contributor-workshop/guides/updating-segment.md new file mode 100644 index 00000000..f3acafd1 --- /dev/null +++ b/mentoring/programs/contributor-workshop/guides/updating-segment.md @@ -0,0 +1,60 @@ +# Updating workshop segments + +This guide covers how to update segments in the Contributor Workshop. + +- [Updating workshop segments](#updating-workshop-segments) + - [Prerequisites](#prerequisites) + - [Fork & Clone the ``contributor-site``](#fork--clone-the-contributor-site) + - [Checkout a branch off the workshop branch for your changes](#checkout-a-branch-off-the-workshop-branch-for-your-changes) + - [Run the site locally with your changes](#run-the-site-locally-with-your-changes) + - [Modifying an existing segment](#modifying-an-existing-segment) + - [Adding a segment to the workshop](#adding-a-segment-to-the-workshop) + - [Adding a video guide to accompany a segment](#adding-a-video-guide-to-accompany-a-segment) + - [Save, Commit, Push, PR](#save-commit-push-pr) + +## Prerequisites + +### Fork & Clone the ``contributor-site`` + +Create a fork of the [``contributor-site``](https://github.com/kubernetes/contributor-site) repo. + +Clone your fork locally + +### Checkout a branch off the workshop branch for your changes + +```bash +git remote add upstream git@github.com:kubernetes/contributor-site.git +git remote set-url --push upstream no_push +git fetch upstream +git checkout workshop +git rebase upstream/workshop +git checkout <your feature branch> +``` + +### Run the site locally with your changes + +Follow the instructions in the top level [``README.md``](https://github.com/kubernetes/contributor-site/tree/master/README.md#running-the-site-locally) on the contributor-site. + +You're now ready to update and add segments! + +## Modifying an existing segment + +Find the file you would like to edit and open it. See [the list of segments](https://github.com/kubernetes/contributor-site/tree/workshop/content/en/workshop/CONTRIBUTING.md#list-of-segments). + +## Adding a segment to the workshop + +Make sure to update [the list of segments](https://github.com/kubernetes/contributor-site/tree/workshop/content/en/workshop/CONTRIBUTING.md#list-of-segments), with the new page. + +If inserting a page between existing pages, make sure to update the page weightings in the frontmatter and [the list of segments](https://github.com/kubernetes/contributor-site/tree/workshop/content/en/workshop/CONTRIBUTING.md#list-of-segments),. + +See [the segment template](../templates/segment-template.md), on how to structure your segment. + +## Adding a video guide to accompany a segment + +With some of the guides, we might want a youtube video to accompany them. You can find the information for adding a video to the guide, in the [video guide](videoguide.md) + +## Save, Commit, Push, PR + +Once you've made the modifications and additions you want, commit and push them to your fork. + +Then make a pull request of your changes into the ``workshop`` branch of the ``contributor-site`` repo. diff --git a/mentoring/programs/contributor-workshop/guides/videoguide.md b/mentoring/programs/contributor-workshop/guides/videoguide.md new file mode 100644 index 00000000..13094925 --- /dev/null +++ b/mentoring/programs/contributor-workshop/guides/videoguide.md @@ -0,0 +1,293 @@ +<!-- omit in toc --> +# Video Recording Guide for Contributor Workshop Segments + +This guide covers, how to structure, record, upload and update video guides associated with workshop segments. + +- [Format / Video Style](#format--video-style) +- [Encoding Guidelines](#encoding-guidelines) + - [Zoom Recording](#zoom-recording) + - [OBS](#obs) + - [Streamyard](#streamyard) + - [Adobe Media Encoder](#adobe-media-encoder) +- [Recording Guides](#recording-guides) + - [Record Using Zoom](#record-using-zoom) + - [Install Windowed extension (optional)](#install-windowed-extension-optional) + - [Start the meeting](#start-the-meeting) + - [Setting up slides for recording](#setting-up-slides-for-recording) + - [Without browser extension](#without-browser-extension) + - [With browser extension](#with-browser-extension) + - [Note : Exiting the windowed mode](#note--exiting-the-windowed-mode) + - [Adding your facecam](#adding-your-facecam) + - [Unmute your audio](#unmute-your-audio) + - [Recording in Zoom](#recording-in-zoom) + - [Note : Do a test recording first](#note--do-a-test-recording-first) + - [How to record](#how-to-record) + - [Recording in OBS](#recording-in-obs) + - [Recording in Streamyard](#recording-in-streamyard) +- [Updating / Adding video to a segment](#updating--adding-video-to-a-segment) + - [Rename your recording](#rename-your-recording) + - [Upload your video to Google Drive](#upload-your-video-to-google-drive) + - [Updating Youtube](#updating-youtube) +- [Update the Segment page with video](#update-the-segment-page-with-video) +- [Best Practices & Recommendations](#best-practices--recommendations) + - [Video](#video) + - [Camera Type](#camera-type) + - [Audio](#audio) + - [Microphone Types](#microphone-types) + - [Sound Environment](#sound-environment) + - [Background Noise](#background-noise) + - [Removing Background noise in Zoom](#removing-background-noise-in-zoom) + - [Removing Background noise with Krisp](#removing-background-noise-with-krisp) + - [Removing Background noise with NVIDIA Broadcast or RTX Voice](#removing-background-noise-with-nvidia-broadcast-or-rtx-voice) + - [Other Tips](#other-tips) + - [Screensharing](#screensharing) + - [Hardware](#hardware) + - [Headset Microphones](#headset-microphones) + - [External Microphones](#external-microphones) + - [Webcams](#webcams) + - [Presentation remotes](#presentation-remotes) + +## Format / Video Style + +You can use any format/style as long as the same information in the guide is captured in the video. Slides, A screenshare, green screen yourself into the repo even! Be creative. + +## Encoding Guidelines + +### Zoom Recording + +Handled by zoom, Can't change these settings. + +### OBS + + + +### Streamyard + +Handled by Streamyard, Can't change these settings. + +### Adobe Media Encoder + +use Youtube 1080p Full HD + +## Recording Guides + +Guides on how to record a presentation style video (slides/screen,facecam) + +### Record Using Zoom + +#### Install Windowed extension (optional) + +This makes it easier for you to share the slides to zoom. Allows you to pop out the fullscreen view to a single window. + +[GitHub Link](https://github.com/dralletje/Windowed) + +#### Start the meeting + +Start a meeting in zoom (you can start and record a meeting with a single participant) + +#### Setting up slides for recording + +Open your slides in Presenter View + + + +It should open a presenter view, with a timer, slide notes, and change the tab from editor to a slideshow presentation + + + +You will use the presenter view to control the slides, and the slide view will be cast to the zoom call. + +##### Without browser extension + +Share the window which is displaying the slides view. + + + +##### With browser extension + +When moving your mouse on the slide view a small dialog with the slide number, and triple dots will appear. Select the triple dots and enter full screen + + + +After selecting the fullscreen option, you will be presented further options on how to display the slides. + +Select the windowed option + + + +A new window with only the slides will appear, Share this window in zoom. + + + +###### Note : Exiting the windowed mode + +To exit out of this view, and go back the editor, select the window with the slide view back into focus, move your mouse until the triple dots mentioned earlier appear. Select the triple dots again and ``Exit Full Screen`` + + + +#### Adding your facecam + +If you haven't done so already, start your video in Zoom. + +#### Unmute your audio + +If you haven't done so already, unmute your audio in Zoom. + +#### Recording in Zoom + +Now that you've got your slides, video and audio setup, you're ready to record! + +##### Note : Do a test recording first + +It's good practice to create a test recording of your whole setup in action. +If you change shares between windows, check that changing the shares appears how you want it to in the video. + +##### How to record + +Select the ``Record`` button in zoom. + +If you have the option between saving locally, and in the cloud, select locally. + +Once you have finished recording, end the meeting. + +A popup should appear with progress on converting the recording. +Once the recording is converted, a file browser window with the recording will be opened. Rename the recording from ``zoom_0.mp4`` to the format described in [Rename your recording](#rename-your-recording) + +### Recording in OBS + +Coming soon + +### Recording in Streamyard + +Coming soon + +## Updating / Adding video to a segment + +### Rename your recording + +Rename your recording to ``YYYY-MM-DD-<Segement Name>-<gh-handle>.mp4`` + +Where + +- ``YYYY-MM-DD`` being date, is the date video was recorded +- ``<Segement Name>`` being the name of the markdown file associated with that segment. see [CONTRIBUTING.md](https://github.com/kubernetes/contributor-site/tree/workshop/content/en/workshop/CONTRIBUTING.md#list-of-segments) +- ``<gh-handle>`` being the github handle of the person who recorded the video, if there are multiple presenters just add another dash and the handle. ``<gh-handle>-<gh-handle>`` + +For example + +``2021-05-10-why-contribute-alisondy.mp4`` + +``2021-05-10-why-contribute-alisondy-mrbobbytables.mp4`` + +### Upload your video to Google Drive + +Upload your recording to the Google Drive folder provided for the Workshop Videos. + +### Updating Youtube + +Once you have uploaded the video to drive, contact one of the [youtube admins](/communication/moderators.md#youtube-channel) to upload it to the Kubernetes YouTube channel. + +> Youtube Admins see [Video Upload Guide](videouploadguide.md) for details about uploading the segment to youtube + +## Update the Segment page with video + +If adding to a segment page where video doesn't exist, Paste this at the top, after the frontmatter. Fill in the details with the youtube id of the video you just uploaded. + +If adding to a segment page where a video already exists, update the youtube id in the shortcode, with the video id of your newly uploaded video. + +```txt +## Video Walkthrough + +{{< youtube id="<id of your video>" title="Contributor Workshop : <Segment Name" >}} +``` + +## Best Practices & Recommendations + +### Video + +#### Camera Type + +Use an external camera or webcam to capture your video. + +Built in webcams restrict the angle of you webcam, to the viewing angle of your display, and often provide a low quality image. + +- Use an external webcam. 1080p preferred or 720p at a minimum. Typically, either will be better quality than the built-in camera on your laptop. +- Lighting - Adjusting your lighting may help you get a better camera feed in less than optimal lighting conditions. + - Optimize the ambient lighting within your space first. + - There should be no window or strong light source behind you that darkens your face + - There should be no strong light source from one side that casts a shadow on the opposite side of your face. + - Good ambient lighting from your ceiling lights or windows may be enough as long as they are in front of you. + - Diffused lighting is better than harsh, direct lighting. +- Background – keep it clean and uncluttered. It’s great to show off your personality/style in your home, just be sure to keep everything appropriate for a general audience and compliant with the Code of Conduct. A plain wall is also just fine, no need to overdo it. +- Camera Position - as close as possible at your eye level, not pointing up towards your nose or the ceiling, or down towards the floor. It can be as simple as raising your laptop via a few books. Or if you have an external webcam, position it on the top edge or close to the top of the screen from which you are advancing your slides/notes. +- Keep eye contact with the camera just like you would look at your audience during an in-person presentation. It's okay to look away for brief moments, just make sure you look towards the camera for the majority of the presentation. +- Video with more lighting tips [https://youtu.be/rGcAM1CNEU0](https://youtu.be/rGcAM1CNEU0) + +### Audio + +#### Microphone Types + +**Best:** External microphone (condenser recommended over dynamic*) via a USB connection or DAC. This type of microphone will pick up audio from a distance as well as up close really well. This means you can position it a fair distance away from yourself when recording. If using one of these microphones, try to position it out of frame from your video. + +**Good:** Headset Microphone, this could be a microphone located on the wires like on mobile earphones, the mic on your wireless earphones as well as the usual fold down microphone on a headset. All of these assist with isolating microphone pick-up from ambient noises within your recording/streaming space. Wired headsets will give you better quality audio than wireless. + +**Acceptable:** External microphone built into your webcam. Often better quality than your built-in laptop microphone. + +**Worst:** Your built-in laptop microphone. These are generally low-quality microphones, and they have little or no ability to filter out background noise. + +#### Sound Environment + +##### Background Noise + +It’s best to be in a controlled environment with little to no background noise. +If this is not possible you can use your recording software and other software to remove background noise. +Another option to filtering out background noise or being in a controlled environment is using push to talk, or unmuting your mic whenever you need to speak. + +###### Removing Background noise in Zoom + +In zoom settings under ``Audio`` +Change the Suppress background noise setting to ``High`` + +###### Removing Background noise with Krisp + +Krisp provides AI powered background noise cancellation, see [krisp.ai](https://krisp.ai/) for more information. + +###### Removing Background noise with NVIDIA Broadcast or RTX Voice + +If you're using Windows, and are using certain models of NVIDIA GPU, you can install either NVIDIA Broadcast or RTX Voice to filter out background noise. See [RTX Voice setup guide](https://www.nvidia.com/en-us/geforce/guides/nvidia-rtx-voice-setup-guide/) and [Broadcast app setup guide](https://www.nvidia.com/en-gb/geforce/guides/broadcast-app-setup-guide/) for more information. + +##### Other Tips + +- Mute all notifications and programs not being recorded +- Disable any unnecessary audio devices + +### Screensharing + +- Increase the font size when sharing terminals, text editors +- Ensure you have all the windows you need opened before recording. +- Export any sensitive variables needed in your terminals before starting your presentation +- If using a passworded ssh key, Start a ssh-agent in the terminal beforehand. + +### Hardware + +Here are some equipment recommendations from the CNCF: + +#### Headset Microphones + +Logitech / Plantronics – i.e. Logitech H111 / Logitech H390 / Plantronics C225 + +#### External Microphones + +Blue / Samson – i.e. Blue Snowball / Blue Yeti / Samson Meteor / Samson G-Track + +#### Webcams + +Good value – Logitech C920 + +More info – [https://www.tomsguide.com/news/where-to-buy-webcams-now-these-retailers-have-stock](https://www.tomsguide.com/news/where-to-buy-webcams-now-these-retailers-have-stock) + +#### Presentation remotes + +Logitech / Canon / Kensington / SMK + +Tested and recommended for PC or Mac – Logitech R400, R800, Spotlight / Canon PR500, PR100 diff --git a/mentoring/programs/contributor-workshop/guides/videouploadguide.md b/mentoring/programs/contributor-workshop/guides/videouploadguide.md new file mode 100644 index 00000000..147bb070 --- /dev/null +++ b/mentoring/programs/contributor-workshop/guides/videouploadguide.md @@ -0,0 +1,97 @@ +# Segment Upload Guide for Youtube Admins + +## Upload the new video + +In youtube, upload the same video and title it as follows + +```txt +Contributor Workshop : <Segment Name> with <Presenter Name> | <Month> <Year> +``` + +For example + +```txt +Contributor Workshop : Why Contribute? with @alisondy | May 2021 +``` + +## Adding the thumbnail image + +```markdown +TODO : Instructions on how to generate a thumbnail image, similar to https://gist.github.com/alisondy/e4ff3b483a32330ade0c880b4a4a10b1 +``` + +Set the thumbnail to the image generated in the previous step + +## Setting the description + +Use the following template for setting the video description + +```txt +This is the video guide for the Contributor Workshop segment <Segment Name> + +Link to this segments page: +https://kubernetes.dev/docs/workshop/<page-name> + +Link to the workshop: +https://kubernetes.dev/docs/workshop/ +``` + +## Update the previous video for the segment if it exists + +If you're updating an already existing video, follow the next steps to update the following on the previous video + +- title +- thumbnail +- description +- comments section + +## Update the title + +Update the title on the previous video to match the following format + +```txt +Contributor Workshop : <Segment Name> | <Month> <Year> | 🚨🚨 DEPRECATED 🚨🚨 +``` + +For example + +```txt +Contributor Workshop : Why Contribute? with @alisondy | May 2021 | 🚨🚨 DEPRECATED 🚨🚨 +``` + +## Update the thumbnail image + +Update the Thumbnail image on the previous video to + +insert-deprecation-thumbnail-here.jpeg + +```txt + + +THIS VIDEO IS DEPRECATED! +See the comments & description for details on where to find the new video guide! + + +``` + +## Update the Description + +On the previous video, add the following to the start of the description + +```txt +🚨🚨 DEPRECATED , Please see <link to new video> 🚨🚨 +``` + +## Update the Comments + +On the previous video, add the following as a comment as Kubernetes YT & pin to the top of the comments + +```txt +🚨🚨 DEPRECATED , Please see <link to new video> 🚨🚨 +``` + +Close the comment section of the deprecated video + +## Update the Playlist + +Update the youtube playlist with the segment recording. Remove the previous version of the video from the playlist if it exists. diff --git a/mentoring/programs/contributor-workshop/live-workshop/README.md b/mentoring/programs/contributor-workshop/live-workshop/README.md new file mode 100644 index 00000000..3958d322 --- /dev/null +++ b/mentoring/programs/contributor-workshop/live-workshop/README.md @@ -0,0 +1,39 @@ +# Live Workshops Resources + +## Overview + +This folder contains the [handbook for the New Contributor Workshop Content Lead](./new-contributor-workshop-lead.md) as well as playbooks for each of the Contributor Workshop sessions in a live setting. + +This workshop is held periodically by the Kubernetes Community, but materials and processes may be used at contributor focused summits and events anywhere. + +Slides from previous New Contributor Workshops can be found [here](https://github.com/cncf/presentations/blob/master/kubernetes/README.md#kubernetes-new-contributor-workshops). + +## Sample Track for Beginner Workshop + +This workshop is meant for folks who have never contributed to opensource before and/or need help setting up a Kubernetes developer environment. + +1. Welcome +1. [Live PR Demo](./live-pr-demo.md) +1. [Paths to Contributorship](./contributor-paths.md) +1. [Communication in the Kubernetes Community](./how-we-communicate.md) +1. [Community Group and Governance Overview](./community-groups.md) +1. [Kubernetes Orgs Overview](./repo-tour.md) +1. [Workspace Setup](./workspace-setup.md) +1. [Local Build&Test](./build-and-test.md) +1. [Pull Request Exercise](./playground-exercise.md) +1. [Find Your First Issue](./first-issue-help.md) + +## Sample Track for Intermediate Workshop + +This workshop differs from the Beginner workshop in that participants are expected to have a working Docker/Kubernetes/Go setup. They have a basic understanding of how opensource contributions work, and may have opened a PR against Kubernetes before. + +1. Welcome +1. [Live PR Demo](./live-pr-demo.md) +1. [Paths to Contributorship](./contributor-paths.md) +1. [Communication in the Kubernetes Community](./how-we-communicate.md) +1. [Community Group and Governance Overview](./community-groups.md) +1. [Kubernetes Orgs Overview](./repo-tour.md) +1. k/k Walkthrough +1. [Local Build&Test](./build-and-test.md) +1. [Labels, Bots and Git Workflow](./labels-and-bots.md) +1. [Find Your First Issue](./first-issue-help.md) diff --git a/mentoring/programs/contributor-workshop/live-workshop/build-and-test.md b/mentoring/programs/contributor-workshop/live-workshop/build-and-test.md new file mode 100644 index 00000000..147d91a3 --- /dev/null +++ b/mentoring/programs/contributor-workshop/live-workshop/build-and-test.md @@ -0,0 +1,27 @@ +## Build and Test + +### Duration + +40-60 minutes, depending on beginner vs intermediate participants + +### Task Overview + +Build Kubernetes binaries locally, and do some fun things with them. + +**Important** Have facilitators to help with technical issues (2-3 is enough for Intermediate, you want 5 for Beginner) + +### Slides + +Clear command line instructions. + +### Details To Cover + +- This is the hands-on part. Details are up to you; look to previous workshops for inspiration. +- Adjust difficulty based on whether this is the Beginner or Intermediate workshop. +- It is _extremely important_ to run this part of the workshop several times previously, and to make sure that versions match those in the [workspace setup](./workspace-setup.md). + +### Ideas + +- Do a fun thing with the Kubernetes [go client](https://git.k8s.io/client-go) and a [kind](https://sigs.k8s.io/kind) cluster. +- Build and modify `kubectl`. +- Try a `make` command; be aware you may need to give docker a lot of space on your machine for a successful build. diff --git a/mentoring/programs/contributor-workshop/live-workshop/community-groups.md b/mentoring/programs/contributor-workshop/live-workshop/community-groups.md new file mode 100644 index 00000000..01a8c80c --- /dev/null +++ b/mentoring/programs/contributor-workshop/live-workshop/community-groups.md @@ -0,0 +1,27 @@ +## Community Groups + +### Duration + +15 minutes + +### Task Overview + +Introduce SIGs, Working Groups, and a tiny bit of governance (if you must). + +### Slides + +Refer to previous workshops for inspirations. + +### Details To Cover + +- SIGs +- Subprojects +- Working Groups +- User Groups +- Committees +- How to Join Any Of The Above + +### Ideas + +- Stay simple. Don't make it too complicated. +- Ask participants to define a few example SIGs via audience interaction.
\ No newline at end of file diff --git a/mentoring/programs/contributor-workshop/live-workshop/contributor-paths.md b/mentoring/programs/contributor-workshop/live-workshop/contributor-paths.md new file mode 100644 index 00000000..d14691eb --- /dev/null +++ b/mentoring/programs/contributor-workshop/live-workshop/contributor-paths.md @@ -0,0 +1,26 @@ +## Contributor Paths + +### Duration + +10-30 minutes + +### Task Overview + +This is about contributor origin stories. + +### Slides + +Refer to previous workshops for inspirations + +### Details To Cover + +- Who can contribute? +- What skills are needed? +- How to Fit Contributions Into Your Job +- Balance knowledge with learning and the needs of the project + +### Ideas + +- Share some contributor origin stories +- Ask the room why they are at the workshop +- Have a few people share their thoughts diff --git a/mentoring/programs/contributor-workshop/live-workshop/first-issue-help.md b/mentoring/programs/contributor-workshop/live-workshop/first-issue-help.md new file mode 100644 index 00000000..b99488af --- /dev/null +++ b/mentoring/programs/contributor-workshop/live-workshop/first-issue-help.md @@ -0,0 +1,31 @@ +## Finding Your First Issue + +### Duration + +20 minutes + +### Task Overview + +Set participants on as much of a paved path to contributor success as possible. +At this point in the workshop, participants should know what kind of issue they want to tackle. + +### Slides + +Refer to previous workshops for inspirations + +### Details To Cover + +- help-wanted and good-first-issue labels +- Up and coming sandbox projects +- Working with your SIG +- Refer participants to specific SIGs +- How to "claim" an issue (since non-members cannot self-assign) +- Path to [membership](/community-membership.md) + +### Ideas + +- Give folks time to discuss and help each other +- Gather information from SIGs in advance (via Slack, Twitter...) on who needs help, and at what level +- Prepare a list of issues and assign folks right there +- Connect participants to mentoring tracks if available (e.g. Release Team Shadow) + diff --git a/mentoring/programs/contributor-workshop/live-workshop/how-we-communicate.md b/mentoring/programs/contributor-workshop/live-workshop/how-we-communicate.md new file mode 100644 index 00000000..777929e2 --- /dev/null +++ b/mentoring/programs/contributor-workshop/live-workshop/how-we-communicate.md @@ -0,0 +1,33 @@ +## How We Communicate + +### Duration + +10-30 minutes + +### Task Overview + +Show how we communicate in the community, and which tools are for what purpose. + +### Slides + +Refer to previous workshops for inspirations. + +### Details To Cover + +- [Code of Conduct](https://git.k8s.io/community/code-of-conduct.md) (CoC) +- Where We Talk: + - Slack + - Discuss +- How We Decide: + - GitHub + - Zoom + - Mailing List +- Calendar +- Meetups + +### Ideas + +- Have a #ncw channel on Slack. The first person who finds the Slack channel with the most members, or the longest name(etc) and posts in here wins a prize! +- Everyone introduces their neighbor and a cool Kubernetes fact about them in a Slack or Discuss channel/topic. +- Put an easter egg in the mailing list and whoever discovers it first by joining and reading the discussions, wins a prize! +- Come up with the most creative TL;DR for the CoC.
\ No newline at end of file diff --git a/mentoring/programs/contributor-workshop/live-workshop/labels-and-bots.md b/mentoring/programs/contributor-workshop/live-workshop/labels-and-bots.md new file mode 100644 index 00000000..0e191f03 --- /dev/null +++ b/mentoring/programs/contributor-workshop/live-workshop/labels-and-bots.md @@ -0,0 +1,25 @@ +## Labels and Bots + +### Duration + +10 - 15 minutes + +### Task Overview + +Show the Kubernetes automation and PR workflow, as well as the bot command help page. +This task is meant as a short overview for Intermediate content. + +### Slides + +The [PR workflow diagram](https://git.k8s.io/community/blob/master/contributors/guide/git_workflow.png) is useful here. There are also previous slides that explain the differnet labels. + +### Details To Cover + +- Which labels are used how, and by whom? +- How to add labels +- Other bot commands +- Prow + +### Ideas + +- Play with bots in the [contributor playground](https://sigs.k8s.io/contributor-playground) diff --git a/mentoring/programs/contributor-workshop/live-workshop/live-pr-demo.md b/mentoring/programs/contributor-workshop/live-workshop/live-pr-demo.md new file mode 100644 index 00000000..27b6c97e --- /dev/null +++ b/mentoring/programs/contributor-workshop/live-workshop/live-pr-demo.md @@ -0,0 +1,24 @@ +## Live PR Demo + +### Duration + +Plan for about 30 minutes + +### Task Overview + +Demonstrate opening a pull request against the [Kubernetes/Kubernetes](https://git.k8s.io/kubernetes) (k/k) repository. There are some docs cleanup good-first-issues, but feel free to show off something you've been working on for a while. + +### Slides + +None; this is a live demo. + +### Details To Cover + +- Make sure to prepare code in advance but only commit locally +- Show the k/k pull request workflow +- Show the PR templates and fill them out, explaining why +- Interact with the bot and briefly mention labels/OWNERS files +- Leave room for questions, but be aware that the workflow will be covered in depth later. + +### Ideas +- ask the audience or a pre-planned reviewer for code review, showing more of the k/k automation diff --git a/mentoring/programs/contributor-workshop/live-workshop/new-contributor-workshop-lead.md b/mentoring/programs/contributor-workshop/live-workshop/new-contributor-workshop-lead.md new file mode 100644 index 00000000..b6398d28 --- /dev/null +++ b/mentoring/programs/contributor-workshop/live-workshop/new-contributor-workshop-lead.md @@ -0,0 +1,54 @@ +# New Contributor Workshop Lead + +## Overview +The New Contributor Workshop Lead is in charge of planning and executing the New Contributor Workshop. They will coordinate with the overall Events Team and the organizers of related activities aimed at new contributors. + +## Skills and Qualifications + +The New Contributor Content Lead must be a current, active Kubernetes contributor who is knowledgeable of the community and organizational structure of the Kubernetes project, as well as familiar with building and developing Kubernetes. +They should have experience and be comfortable with teaching in a workshop setting and presenting interactively in front of an audience. +Additionally, they must be able to relate to and empathize with newcomers of many different experience levels. +As this role is part of a subproject of SIG-contributor-experience, the New Contributor Content Lead must be a member of SIG-contributor-experience. + +## Activities + +*These tasks reflect a rough timeline leading from the end of the previous New Contributor Workshop to the currently planned one.* +- Attend event planning meetings in preparation for the New Contributor Workshop, where applicable. +- Create a Workshop Content Proposal and link in an Issue to k/community: + - determine sessions and their overall topic (e.g. How We Communicate, Code Base Walkthrough, etc) + - determine what difficulty/experience levels will be offered, if any, and coordinate with Lead + - determine workshop capacity, and coordinate with Lead + - determine room requirements (size, number, table/chair layout, A/V) and coordinate with the planning team +- Coordinate with New Contributor Content Shadows to prepare them for leading this role. +- Recruit and coordinate with workshop teachers for any sessions/topics you do not wish to teach yourself (e.g. invite someone to speak on "Communication in the Kubernetes Project"). +- Make modifications and continuous improvements to the new contributor workshop template. +Incorporate feedback from previous New Contributor Workshops. +Shadows and co-presenters are expected to assist and review these updates. +[Past presentations are linked here](https://github.com/cncf/presentations/tree/master/kubernetes) - please make a copy of the existing deck before updating/editing. +- Work with Registration to: + - disseminate course materials (slides) in advance + - ensure participants sign the CLA + - ensure attendees meet technical and experience requirements for their course + - obtain a comprehensive list of names, emails, and GitHub handles +- Ensure to advertise the SIG-Intros. +- Solicit feedback from workshop participants. + +## Time Commitment + +1-2 hours/week most of the time, 4-5 in the weeks leading up to NCW, depending on previous teaching/shadowing experience. + +## Coupon Codes + +If you would like to share coupon codes for the CNCF store with your +attendees, please create an issue in the [kubernetes/funding] repo and +assign [SIG Contributor Experience chairs] for approval. + +The funding request should contain the following details: +- Number of coupon codes required +- Desired amount of each coupon code (e.g. $20) OR desired swags for each coupon code (e.g. 1 Tshirt, 2 stickers) + +Once the request is approved, the chairs will create a CNCF Service Desk +ticket to get the list of coupon codes. + +[kubernetes/funding]: https://github.com/kubernetes/funding +[SIG Contributor Experience chairs]: /sig-contributor-experience#chairs diff --git a/mentoring/programs/contributor-workshop/live-workshop/playground-exercise.md b/mentoring/programs/contributor-workshop/live-workshop/playground-exercise.md new file mode 100644 index 00000000..6aca9178 --- /dev/null +++ b/mentoring/programs/contributor-workshop/live-workshop/playground-exercise.md @@ -0,0 +1,28 @@ +## Playground Exercise + +### Duration + +30 - 50 minutes + +### Task Overview + +Give new contributors the experience of the Kubernetes GitHub workflow! +This task requires some setup and planning. + +Create a New Contributor Workshop folder specific to this event, with teachers' and participants' GitHub handles in the OWNERS file. +[Here is an example](https://sigs.k8s.io/contributor-playground/seattle). Make sure to obtain participants' GitHub handles from the event registrar in advance. +Issue and PR exercise ideas can be found [here](https://sigs.k8s.io/contributor-playground/exercises). + +### Slides + +Refer to previous workshops for inspirations. + +### Details To Cover + +- Labels and bot commands - more material [here](./labels-and-bots.md) +- Automation +- How to assign reviewers + +### Ideas + +- The first person to `/honk` on a PR wins a prize! diff --git a/mentoring/programs/contributor-workshop/live-workshop/repo-tour.md b/mentoring/programs/contributor-workshop/live-workshop/repo-tour.md new file mode 100644 index 00000000..d1f46ee0 --- /dev/null +++ b/mentoring/programs/contributor-workshop/live-workshop/repo-tour.md @@ -0,0 +1,24 @@ +## Repo Tour + +### Duration + +10 - 15 minutes + +### Task Overview + +Show that Kubernetes is not just about the Core Repository, but also about the other repos in the org and in kubernetes-sigs. + +### Slides + +Have a few overview slides, but also go off-book and live show the repos on GitHub. + +### Details To Cover + +- k/website, k/test-infra, k/community, k/enhancements, with explanations +- Exciting things in kubernetes-sigs + + +### Ideas + +- Ask participants if they have found or are interested in specific repos, and share about their purpose. +- Mention which repos need help, or have awesome good-first-issue shepherding from maintainers!
\ No newline at end of file diff --git a/mentoring/programs/contributor-workshop/live-workshop/workspace-setup.md b/mentoring/programs/contributor-workshop/live-workshop/workspace-setup.md new file mode 100644 index 00000000..19dbef29 --- /dev/null +++ b/mentoring/programs/contributor-workshop/live-workshop/workspace-setup.md @@ -0,0 +1,24 @@ +## Workspace Setup + +### Duration + +Plan for 90- 120 minutes of download and setup time when on wifi. When on a workshop specific network, this may be much shortened. + +### Task Overview + +Make sure all Beginning Contributors have a workspace setup for hacking on Kubernetes. + +**Important** Have facilitators to help with technical issues (3-5 for ~30 people) + +### Slides + +Clear and large download commands to copy into the terminal. + +### Details To Cover + +- Make sure everyone has the correct setup for a local build and test demo. + +### Ideas + +- Have a dedicated workshop network. +- When internet is slow, start the download and prep process during earlier sessions, to make sure everyone is up to date. diff --git a/mentoring/programs/contributor-workshop/templates/segment-template.md b/mentoring/programs/contributor-workshop/templates/segment-template.md new file mode 100644 index 00000000..dc413799 --- /dev/null +++ b/mentoring/programs/contributor-workshop/templates/segment-template.md @@ -0,0 +1,33 @@ +--- +title: "Segment Name" # The name of the page +weight: 2 # Ordering of the page +description: | + A brief description of what this segment aims to cover. +--- + +## Goals + +<!-- What will the person reading this documentation get out of it--> +By the end of this segment you should be able to: +* Identify areas of Kubernetes you would like to contribute to +* Understand the differences between Special Interest Groups, Working Groups and Subprojects + +## Subsection Heading + +<!-- Some content over here --> + +## Another Subsection Heading + +<!-- Some content over here --> + +## Exercise : Name Of Exercise + +<!-- Description of a hands on activity --> + +### Name Of First Step + +<!-- Details on what this step entails --> + +### Name Of Second Step + +<!-- Details on what this step entails --> |
