diff options
Diffstat (limited to 'mentoring/programs')
32 files changed, 557 insertions, 480 deletions
diff --git a/mentoring/programs/new-contributor-workshop/OWNERS b/mentoring/programs/contributor-workshop/OWNERS index 0c10d897..0c10d897 100644 --- a/mentoring/programs/new-contributor-workshop/OWNERS +++ b/mentoring/programs/contributor-workshop/OWNERS 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/new-contributor-workshop/resources/README.md b/mentoring/programs/contributor-workshop/live-workshop/README.md index 917fb5a0..3958d322 100644 --- a/mentoring/programs/new-contributor-workshop/resources/README.md +++ b/mentoring/programs/contributor-workshop/live-workshop/README.md @@ -1,9 +1,8 @@ -# New Contributor Workshops Resources - +# 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 New Contributor Workshop sessions. +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. diff --git a/mentoring/programs/new-contributor-workshop/resources/build-and-test.md b/mentoring/programs/contributor-workshop/live-workshop/build-and-test.md index 147d91a3..147d91a3 100644 --- a/mentoring/programs/new-contributor-workshop/resources/build-and-test.md +++ b/mentoring/programs/contributor-workshop/live-workshop/build-and-test.md diff --git a/mentoring/programs/new-contributor-workshop/resources/community-groups.md b/mentoring/programs/contributor-workshop/live-workshop/community-groups.md index 01a8c80c..01a8c80c 100644 --- a/mentoring/programs/new-contributor-workshop/resources/community-groups.md +++ b/mentoring/programs/contributor-workshop/live-workshop/community-groups.md diff --git a/mentoring/programs/new-contributor-workshop/resources/contributor-paths.md b/mentoring/programs/contributor-workshop/live-workshop/contributor-paths.md index d14691eb..d14691eb 100644 --- a/mentoring/programs/new-contributor-workshop/resources/contributor-paths.md +++ b/mentoring/programs/contributor-workshop/live-workshop/contributor-paths.md diff --git a/mentoring/programs/new-contributor-workshop/resources/first-issue-help.md b/mentoring/programs/contributor-workshop/live-workshop/first-issue-help.md index b99488af..b99488af 100644 --- a/mentoring/programs/new-contributor-workshop/resources/first-issue-help.md +++ b/mentoring/programs/contributor-workshop/live-workshop/first-issue-help.md diff --git a/mentoring/programs/new-contributor-workshop/resources/how-we-communicate.md b/mentoring/programs/contributor-workshop/live-workshop/how-we-communicate.md index 777929e2..777929e2 100644 --- a/mentoring/programs/new-contributor-workshop/resources/how-we-communicate.md +++ b/mentoring/programs/contributor-workshop/live-workshop/how-we-communicate.md diff --git a/mentoring/programs/new-contributor-workshop/resources/labels-and-bots.md b/mentoring/programs/contributor-workshop/live-workshop/labels-and-bots.md index 0e191f03..0e191f03 100644 --- a/mentoring/programs/new-contributor-workshop/resources/labels-and-bots.md +++ b/mentoring/programs/contributor-workshop/live-workshop/labels-and-bots.md diff --git a/mentoring/programs/new-contributor-workshop/resources/live-pr-demo.md b/mentoring/programs/contributor-workshop/live-workshop/live-pr-demo.md index 27b6c97e..27b6c97e 100644 --- a/mentoring/programs/new-contributor-workshop/resources/live-pr-demo.md +++ b/mentoring/programs/contributor-workshop/live-workshop/live-pr-demo.md diff --git a/mentoring/programs/new-contributor-workshop/resources/new-contributor-workshop-lead.md b/mentoring/programs/contributor-workshop/live-workshop/new-contributor-workshop-lead.md index b6398d28..b6398d28 100644 --- a/mentoring/programs/new-contributor-workshop/resources/new-contributor-workshop-lead.md +++ b/mentoring/programs/contributor-workshop/live-workshop/new-contributor-workshop-lead.md diff --git a/mentoring/programs/new-contributor-workshop/resources/playground-exercise.md b/mentoring/programs/contributor-workshop/live-workshop/playground-exercise.md index 6aca9178..6aca9178 100644 --- a/mentoring/programs/new-contributor-workshop/resources/playground-exercise.md +++ b/mentoring/programs/contributor-workshop/live-workshop/playground-exercise.md diff --git a/mentoring/programs/new-contributor-workshop/resources/repo-tour.md b/mentoring/programs/contributor-workshop/live-workshop/repo-tour.md index d1f46ee0..d1f46ee0 100644 --- a/mentoring/programs/new-contributor-workshop/resources/repo-tour.md +++ b/mentoring/programs/contributor-workshop/live-workshop/repo-tour.md diff --git a/mentoring/programs/new-contributor-workshop/resources/workspace-setup.md b/mentoring/programs/contributor-workshop/live-workshop/workspace-setup.md index 19dbef29..19dbef29 100644 --- a/mentoring/programs/new-contributor-workshop/resources/workspace-setup.md +++ b/mentoring/programs/contributor-workshop/live-workshop/workspace-setup.md 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 --> diff --git a/mentoring/programs/new-contributor-workshop/2020/03-contributor-summit/README.md b/mentoring/programs/new-contributor-workshop/2020/03-contributor-summit/README.md deleted file mode 100644 index 283fe402..00000000 --- a/mentoring/programs/new-contributor-workshop/2020/03-contributor-summit/README.md +++ /dev/null @@ -1,13 +0,0 @@ -## NCW Workshop Amsterdam - -## Team - -| Name & Handle | Role | Timezone | -|---------------|------|----------| -| | | | -| | | | -| | | | - -## Deadlines - -## Meeting Information diff --git a/mentoring/programs/new-contributor-workshop/2020/03-contributor-summit/content-proposal.md b/mentoring/programs/new-contributor-workshop/2020/03-contributor-summit/content-proposal.md deleted file mode 100644 index 93ea95d3..00000000 --- a/mentoring/programs/new-contributor-workshop/2020/03-contributor-summit/content-proposal.md +++ /dev/null @@ -1,165 +0,0 @@ -# Content Proposal for NCW Amsterdam - -## Introduction - -### 9:30 - 11:00 Intro Communications and Community -Alison, Rob, Rael, Josh: support/segment? - -Provide an overview on how the community works as a project both in terms of coordinating people and the special interest groups that those people participate in and the workflow that are used to accept new features, bug fixes. - -Note: Although these will have to be run separately, the content will be the same. - -## NCW Topics 101 - -This workshop will help a complete newcomer to Kubernetes get a running start as a contributor. Learn how to set up your developer environment, how to find your first contribution, and how to navigate the Kubernetes GitHub workflow. We will focus on a community approach to solving challenges, and on being good open source citizens. - -### Morning Session - -#### 11:00 - 12:00 [Workspace Setup](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/workspace-setup.md) Tim & Rael - -Make sure all Beginning Contributors have a workspace setup for hacking on Kubernetes - -#### 12:00 - 12:30 [Local Build Test](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/build-and-test.md) Tim & Rael -#### 13:30 - 14:00 [Local Build Test](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/build-and-test.md) Tim & Rael - -Build Kubernetes binaries locally, and do some fun things with them. - -### Afternoon Sessions - -#### 14:00 - 14:45 [Pull Request Exercise](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/playground-exercise.md) Guinevere, Rob - -Give new contributors the experience of the Kubernetes GitHub workflow! - -This task requires some setup and planning. Labels, Bots - -#### 14:45 - 15:15 [Find Your First Issue](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/first-issue-help.md) Jeff - -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. - -## NCW Topics 201 - -This workshop focuses on the **more experienced** open source contributor. You may have sent patches to Kubernetes before, but may have gotten stuck or overwhelmed somewhere along the line. Take your contributor journey to the next level by learning about the main Kubernetes code base, how to build and test Kubernetes, and how to find reviewers and collaborators for your issue patches. - -### Morning Session - -#### 11:00 - 12:00 K/K Walkthrough Alison - -Alison - -Guided tour of the main k/k repository, to build a broader understanding of how the codebase is structured - -#### 12:00 - 12:25 Labels, Bots and Git Workflow Guin & Rob - -In this session, we will cover how contributors interact with the kubernetes codebase on github. Join us as we dive into the Git Workflow used throughout the kubernetes project, including how Labels and Bots play a key role in managing issues and prs. - -### Afternoon Sessions - -#### 13:30 - 14:30 [Local Build & Test](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/build-and-test.md) - 1hour ( Or Maybe More? ) Ben - -Build Kubernetes binaries locally, and do some fun things with them. - -#### 14:30 - 14:50 You! Yes you can review a PR! 15-20m Alison & Tim H - -In this session attendees will learn the in’s and outs of reviewing pull requests. We will go through a reviewing a pull request onstage, and provide some good starting points. - -#### 14:50 - 15:15 [Finding Your First Issue](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/first-issue-help.md) / Closing Remarks 15m - -To close the Intermediate contributor workshop, The intermediate contributor workshop team will share their tips and tricks of finding a first issue, and stories of their first contributions. - -## Resources To Create - -* Capture who is presenting what - -* Slides to reflect the content proposal - -* Assign presenters for each section so presenters own their own slides - -* Docker Image Registry - - * Source Tree in a Docker Image incase of networking issues - - * [Sheet of what will be on the Harbor box](https://docs.google.com/spreadsheets/d/1_CUFluzIgeHt4vra9hs6OqBqDZQ8oUl9Og-IixkoEAM/edit?usp=sharing) - - * Add the needed container images, other binaries you want, and specific versions - -* Know before you go details - - * Instructions, What to install on your laptop, Sign the CLA - -* Can we link and update the handbooks here? Every presenter can update the handbooks as content matures! - -* On the day plan - More indepth dive of what happens - -### On The Day / Extra Notes -[runbook.md](runbook.md) - -### Handbooks -[../resources](../resources) - -### Slides -[https://docs.google.com/presentation/d/19OtCzuDTVeeIfMD39OOODGJzkV3UGM_nr7jpSNhoy2s/edit?ts=5e4b8bc8#slide=id.g52cc57d172_7_69](https://docs.google.com/presentation/d/19OtCzuDTVeeIfMD39OOODGJzkV3UGM_nr7jpSNhoy2s/edit?ts=5e4b8bc8#slide=id.g52cc57d172_7_69) - -## Slide Ideas - -* Solidify formatting for each type of slide - - * Code with instructions - - * Main Image - - * Image with text - - * Title Slides - - * Schedule Slides - -* Retro notes - Be a bit more creative with the slides, Do we want to do a direct copy paste of the slides from last time - -* From San Diego page -*Try to represent the journey of a contributor with the slides* - -* *Linking the key ideas themes, with walking along a brick road or similar. From cat to kubecat. *Or capybara to kubeybara - -* Break Slides - -* *Is a long presentation, adding a timeline at the bottom can help the attendees follow the presentation. This can go with the idea of showing the progress of the contributor as we move forward with the presentation. - I love this! -guin* - -## References - -San Diego Contributor Summit Content Proposal - -[https://docs.google.com/document/d/1ha3KtgLcRIY7IaRi9pm_h28xVsx9VoVLu8Fl1YO-eCI/edit?pli=1#heading=h.c2mvd8re7lpn](https://docs.google.com/document/d/1ha3KtgLcRIY7IaRi9pm_h28xVsx9VoVLu8Fl1YO-eCI/edit?pli=1#heading=h.c2mvd8re7lpn) - -Last years sched for san diego - -[https://kcsna2019.sched.com/](https://kcsna2019.sched.com/) - -Reference - -[https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/README.md](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/README.md) - -## Virtual Event Go/No Go - -Alison: Go (speaking live) - -Jeff: Go (streaming/speaking live) - -Josh: Go (pre-record; virtual Q&A) - -Guin: Go (pre-record) - -James M: - -Rob: Go (Flexible; assign content ASAP) - -Chris Short: Go (shadow; streaming) - -Samudrala: Can present - -Nabarun: Can present - -Tim P: Can present (shadow) - -Rael: No Go - -Ben: No Go diff --git a/mentoring/programs/new-contributor-workshop/2020/03-contributor-summit/runbook.md b/mentoring/programs/new-contributor-workshop/2020/03-contributor-summit/runbook.md deleted file mode 100644 index 57369a71..00000000 --- a/mentoring/programs/new-contributor-workshop/2020/03-contributor-summit/runbook.md +++ /dev/null @@ -1,160 +0,0 @@ -# NCW On The Day Runbook / Extra Notes - -### 9:30 - 11:00 Intro Communications and Community -Alison, Rob, Rael, Josh: support/segment? - -Sections - -* Welcome & PR Demo [Slide 6](https://docs.google.com/presentation/d/19OtCzuDTVeeIfMD39OOODGJzkV3UGM_nr7jpSNhoy2s/edit#slide=id.g64b51f6423_1_0) - -* Why Contribute / Origin Story [Slide 10](https://docs.google.com/presentation/d/19OtCzuDTVeeIfMD39OOODGJzkV3UGM_nr7jpSNhoy2s/edit#slide=id.g5e6254b17b_4_1168) - - * Why - - * Origin Story - - * Choose your adventure - - * Find your topic - -* Communications [Slide 13](https://docs.google.com/presentation/d/19OtCzuDTVeeIfMD39OOODGJzkV3UGM_nr7jpSNhoy2s/edit#slide=id.g5e6254b17b_4_1185) - - * How we communicate - - * Standards - - * Asking tech Q’s - -* Community Groups/Organization/SIG Tour: Josh? [Slide 29](https://docs.google.com/presentation/d/19OtCzuDTVeeIfMD39OOODGJzkV3UGM_nr7jpSNhoy2s/edit#slide=id.g5e6254b17b_4_1266) - -* Repo Tour: Samudrala [Slide 52](https://docs.google.com/presentation/d/19OtCzuDTVeeIfMD39OOODGJzkV3UGM_nr7jpSNhoy2s/edit#slide=id.g645f82e308_0_17) - -* How to find what you need: Alison [Slide 55](https://docs.google.com/presentation/d/19OtCzuDTVeeIfMD39OOODGJzkV3UGM_nr7jpSNhoy2s/edit#slide=id.g7eae03886b_2_18) - - * https://cs.k8s.io/ - -Josh: I can take any of the above that someone else doesn't want. - -#### Notes and cool ideas - -#### Communications Tools - -Discuss, Slack, Mailing List, Github, Twitter - -#### Kubernetes Podcasts - -#### Periodic Meetings - -Office Hours, Community Meeting - -#### Scavenger Hunt - -Register in k8s slack, post a Hi to the New Contributor Workshop Room - -Post a commit made by Joe Beda that contains a TODO to a special NCW Amsterdam discuss Thread. Oldest TODO wins. - -Find and favorite a NCW Easter Egg post in the NCW Amsterdam room - -Find and heart a k8s First Good Issue on Github - -#### -Main content - -Live PR Demo - -Paths to Contributorship - -Communication in the Kubernetes Community - -Community Group and Governance - -Orgs Overview - -How to find what you need in the community - -Tips and tricks to interact with the community -Teach people to answer their own questions - -[cs.k8s.io](https://cs.k8s.io/) - -How to phrase questions - -Limitations of GitHub searches - -Traversing K8s docs - -List speakers and roles for each section - -## NCW Topics 101 - -### 11:00 - 12:00 [Workspace Setup](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/workspace-setup.md) Tim & Rael - -**Make sure all Beginning Contributors have a workspace setup for hacking on Kubernetes** - -### 12:00 - 12:30 [Local Build Test](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/build-and-test.md) Tim & Rael - -### 13:30 - 14:00 [Local Build Test](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/build-and-test.md) **Tim & Rael** - -**Build Kubernetes binaries locally, and do some fun things with them.** - -### 14:00 - 14:45 [Pull Request Exercise](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/playground-exercise.md) **Guinevere, Rob** - -**Give new contributors the experience of the Kubernetes GitHub workflow! ** - -**This task requires some setup and planning. Labels, Bots** - -### 14:45 - 15:15 [Find Your First Issue](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/first-issue-help.md) **Jeff** - -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. - -## NCW Topics 201 - -### Morning Session - -### K/K Walkthrough 11:00 - 12:00 - -Alison - -Guided tour of the main k/k repository, to build a broader understanding of how the codebase is structured - -### Labels, Bots and Git Workflow 12:00 - 12:25 - -Guin & Rob - -In this session, we will cover how contributors interact with the kubernetes codebase on github. Join us as we dive into the Git Workflow used throughout the kubernetes project, including how Labels and Bots play a key role in managing issues and prs. - -### Afternoon Sessions - -### [Local Build & Test](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/build-and-test.md) - 1hour ( Or Maybe More? ) 13:30 - 14:30 - -Ben - -Build Kubernetes binaries locally, and do some fun things with them. - -* Live workshop - -* This part can be really flexible - -* Walkthrough workspace set up - -* Step-by-step DevProcess - -* Fun with Go and Kind cluster ( some previous examples) - -* Resolving set up issues - -* Could we do something else here? - -* Modify a controllers behavior - -### You! Yes you can review a PR! 15-20m 14:30 - 14:50 - -Alison? With help from Tim -Look at Tim’s talk from SD - -In this session attendees will learn the in’s and outs of reviewing pull requests. We will go through a reviewing a pull request onstage, and provide some good starting points. - -### [Finding Your First Issue](https://github.com/kubernetes/community/blob/master/events/events-team/content/new-contributor-workshops/first-issue-help.md) / Closing Remarks 15m 14:50 - 15:15 - -To close the Intermediate contributor workshop, The intermediate contributor workshop team will share their tips and tricks of finding a first issue, and stories of their first contributions. - diff --git a/mentoring/programs/new-contributor-workshop/README.md b/mentoring/programs/new-contributor-workshop/README.md deleted file mode 100644 index c0ebd557..00000000 --- a/mentoring/programs/new-contributor-workshop/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# NCW Workshops - -## Upcoming Workshops - -None scheduled - -## Previous 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/new-contributor-workshop/videoguide.md b/mentoring/programs/new-contributor-workshop/videoguide.md deleted file mode 100644 index 2e96183f..00000000 --- a/mentoring/programs/new-contributor-workshop/videoguide.md +++ /dev/null @@ -1,131 +0,0 @@ -# Video Recording Guide for NCW2 DRAFT - - -## Introduction - - -## Setting up Your Video Environment - - -### Video - -The primary video in your NCW presentation will be screen-sharing, but it's also great if you can have some webcam segments. New contributors want to see the faces of current contributors. - - -#### Webcam Recording - -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. They often have an autofocus function and auto - -lighting adjustments that help you get a better camera feed in less than optimal lighting conditions. - -It’s best to optimize the ambient lighting within your space first. There should be no window or strong light source behind you that darkens your face and 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. - - - - - -Webcam tips: - - - -* 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. -* Position the camera 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. -* Check [https://drive.google.com/drive/u/1/folders/1cvGcRgX9IWNR_csNVJ0nWRYD65Wmx9hu](https://drive.google.com/drive/u/1/folders/1cvGcRgX9IWNR_csNVJ0nWRYD65Wmx9hu) for virtual background images if you’d like to use them. - -Please, check the 4 minute video: [https://youtu.be/rGcAM1CNEU0](https://youtu.be/rGcAM1CNEU0) for more tips and examples. - - -#### Resolution - -Videos should ideally be recorded at 1080p or 720p if you’re using a video device, or at one of the following resolutions for screencasts: - - - -* 1440x1080 -* 1440x900 -* 1280x960 -* 1368x768 -* 1280x800 -* 1280x720 -* 1024x768 - -Particularly, do not record the video on the highest resolution your computer offers, such as 3200x1800. Such large screen sizes will make it difficult for folks with low bandwidth or older computers to view your broadcast. If you have a high-resolution screen on your computer, this may mean downgrading the resolution for screencasting. - - -### Audio - -Good audio is important. All recorded NCW segments have audio and this is the most important element that reinforces your presentation slides. In addition to software, you'll need hardware for recording audio. We realize that you don't necessarily have a chance to purchase or borrow the best audio equipment for an NCW video, but here's a few recommendations: - -**Best:** External microphone (condenser recommended over dynamic*) usually via a USB connection (e.g. Blue / Rhode / Razer brands). This type of microphone allows you to keep your mouth somewhat distant from the microphone, not up very close. You should try to keep it out of the video shot. - -**Good:** A headset with microphone, even if it’s earbud type with the mic on the lanyard. It’s about isolating microphone pick-up from ambient noises within your recording/streaming space. Input via USB or single mini-jack is typical or it can be dual minijack for older laptops/PCs. Cordless headsets also work, but it's better to use radio frequency dongles (RF) than bluetooth, which tends to produce sound quality issues. - -**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. - -In general, it’s best to be in a controlled environment with little to no background noise and mute all other audio devices that are not necessary. - - - - -### Console Sessions - -Please, don’t forget to increase the font size when sharing a console. - - -## Recording Options and Instructions - - -### Zoom - - - -* Start a meeting in zoom (you can start and record a meeting with a single participant) -* Get the presentation slide setup with the screenshare. -* Once thats all setup click the record button -* when you click end meeting the video should export locally if you're doing the local record option -* Rename and copy mp4 file to google drive folder: [https://drive.google.com/drive/u/1/folders/1cvGcRgX9IWNR_csNVJ0nWRYD65Wmx9hu](https://drive.google.com/drive/u/1/folders/1cvGcRgX9IWNR_csNVJ0nWRYD65Wmx9hu) - - - -### Documentation and Exercises - - -### Where to Upload - -[https://drive.google.com/drive/u/1/folders/1cvGcRgX9IWNR_csNVJ0nWRYD65Wmx9hu](https://drive.google.com/drive/u/1/folders/1cvGcRgX9IWNR_csNVJ0nWRYD65Wmx9hu) - please upload all video files here. - - -## Tips - - -## Equipment Recommendations - -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 C270 - -Value + added features – Logitech B525/C615 - -Higher resolution, better microphone – Logitech 9series / Microsoft LifeCam - -More info – 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 - |
