Skip to content

Commit 8c45b72

Browse files
committed
Update guides, break out YT admin doc
1 parent 6507ccf commit 8c45b72

File tree

3 files changed

+187
-186
lines changed

3 files changed

+187
-186
lines changed
73.5 KB
Loading

mentoring/programs/contributor-workshop/resources/guides/videoguide.md

Lines changed: 90 additions & 186 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,82 @@
1+
<!-- omit in toc -->
12
# Video Recording Guide for Contributor Workshop Segments
23

34
This guide covers, how to structure, record, upload and update video guides associated with workshop segments.
45

5-
- [Video Recording Guide for Contributor Workshop Segments](#video-recording-guide-for-contributor-workshop-segments)
6-
- [Format / Video Style](#format--video-style)
7-
- [Encoding Guidelines](#encoding-guidelines)
8-
- [Zoom Recording](#zoom-recording)
9-
- [OBS](#obs)
10-
- [Streamyard](#streamyard)
11-
- [Adobe Media Encoder](#adobe-media-encoder)
12-
- [Recording Guides](#recording-guides)
6+
- [Format / Video Style](#format--video-style)
7+
- [Encoding Guidelines](#encoding-guidelines)
8+
- [Zoom Recording](#zoom-recording)
9+
- [OBS](#obs)
10+
- [Streamyard](#streamyard)
11+
- [Adobe Media Encoder](#adobe-media-encoder)
12+
- [Recording Guides](#recording-guides)
13+
- [Record Using Zoom](#record-using-zoom)
14+
- [Install Windowed extension (optional)](#install-windowed-extension-optional)
15+
- [Start the meeting](#start-the-meeting)
16+
- [Setting up slides for recording](#setting-up-slides-for-recording)
17+
- [Without browser extension](#without-browser-extension)
18+
- [With browser extension](#with-browser-extension)
19+
- [Note : Exiting the windowed mode](#note--exiting-the-windowed-mode)
20+
- [Adding your facecam](#adding-your-facecam)
21+
- [Unmute your audio](#unmute-your-audio)
1322
- [Recording in Zoom](#recording-in-zoom)
14-
- [Install Windowed extension (optional)](#install-windowed-extension-optional)
15-
- [Start the meeting](#start-the-meeting)
16-
- [Setting up slides for recording](#setting-up-slides-for-recording)
17-
- [Without browser extension](#without-browser-extension)
18-
- [With browser extension](#with-browser-extension)
19-
- [Note : Exiting the windowed mode](#note--exiting-the-windowed-mode)
20-
- [Adding your facecam](#adding-your-facecam)
21-
- [Unmute your audio](#unmute-your-audio)
22-
- [Recording in Zoom](#recording-in-zoom-1)
23-
- [Note : Do a test recording first](#note--do-a-test-recording-first)
24-
- [How to record](#how-to-record)
25-
- [Recording in OBS](#recording-in-obs)
26-
- [Recording in Streamyard](#recording-in-streamyard)
27-
- [Updating / Adding video to a segment](#updating--adding-video-to-a-segment)
28-
- [Rename your recording](#rename-your-recording)
29-
- [Update Google Drive](#update-google-drive)
30-
- [Uploading your video](#uploading-your-video)
31-
- [What folder to upload to](#what-folder-to-upload-to)
32-
- [Updating Youtube](#updating-youtube)
33-
- [Upload the new video](#upload-the-new-video)
34-
- [Adding the thumbnail image](#adding-the-thumbnail-image)
35-
- [Setting the description](#setting-the-description)
36-
- [Update the previous video for the segment if it exists](#update-the-previous-video-for-the-segment-if-it-exists)
37-
- [Update the title](#update-the-title)
38-
- [Update the thumbnail image](#update-the-thumbnail-image)
39-
- [Update the Description](#update-the-description)
40-
- [Update the Comments](#update-the-comments)
41-
- [Updating the Segment page with video](#updating-the-segment-page-with-video)
42-
- [Best Practices & Recommendations](#best-practices--recommendations)
43-
- [Video](#video)
44-
- [Camera Type](#camera-type)
45-
- [Audio](#audio)
46-
- [Microphone Types](#microphone-types)
47-
- [Sound Environment](#sound-environment)
48-
- [Background Noise](#background-noise)
49-
- [Other Tips](#other-tips)
50-
- [Screensharing](#screensharing)
51-
- [Hardware](#hardware)
52-
- [Headset Microphones](#headset-microphones)
53-
- [External Microphones](#external-microphones)
54-
- [Webcams](#webcams)
55-
- [Presentation remotes](#presentation-remotes)
23+
- [Note : Do a test recording first](#note--do-a-test-recording-first)
24+
- [How to record](#how-to-record)
25+
- [Recording in OBS](#recording-in-obs)
26+
- [Recording in Streamyard](#recording-in-streamyard)
27+
- [Updating / Adding video to a segment](#updating--adding-video-to-a-segment)
28+
- [Rename your recording](#rename-your-recording)
29+
- [Uploading your video to Google Drive](#uploading-your-video-to-google-drive)
30+
- [Updating Youtube](#updating-youtube)
31+
- [Update the Segment page with video](#update-the-segment-page-with-video)
32+
- [Best Practices & Recommendations](#best-practices--recommendations)
33+
- [Video](#video)
34+
- [Camera Type](#camera-type)
35+
- [Audio](#audio)
36+
- [Microphone Types](#microphone-types)
37+
- [Sound Environment](#sound-environment)
38+
- [Background Noise](#background-noise)
39+
- [Removing Background noise in Zoom](#removing-background-noise-in-zoom)
40+
- [Removing Background noise with Krisp](#removing-background-noise-with-krisp)
41+
- [Removing Background noise with NVIDIA Broadcast or RTX Voice](#removing-background-noise-with-nvidia-broadcast-or-rtx-voice)
42+
- [Other Tips](#other-tips)
43+
- [Screensharing](#screensharing)
44+
- [Hardware](#hardware)
45+
- [Headset Microphones](#headset-microphones)
46+
- [External Microphones](#external-microphones)
47+
- [Webcams](#webcams)
48+
- [Presentation remotes](#presentation-remotes)
5649

5750
## Format / Video Style
5851

59-
You can use any format/style as long as the same information in the guide is captured in the video. Slides, A screenshare, greenscreen yourself into the repo even! Be creative.
52+
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.
6053

6154
## Encoding Guidelines
6255

6356
### Zoom Recording
57+
6458
Handled by zoom, Can't change these settings.
6559

6660
### OBS
67-
(todo : match with media encoder)
68-
type : standard
69-
recording format : mp4
70-
encoder: x264
71-
rescale: 1920x1080
72-
rate control : VBR
73-
bitrate : 16000kbps
74-
CRF : ???
61+
62+
![OBS Settings](obssettings.png)
7563

7664
### Streamyard
65+
7766
Handled by Streamyard, Can't change these settings.
7867

7968
### Adobe Media Encoder
69+
8070
use Youtube 1080p Full HD
8171

8272
## Recording Guides
8373

8474
Guides on how to record a presentation style video (slides/screen,facecam)
8575

86-
### Recording in Zoom
76+
### Record Using Zoom
8777

8878
#### Install Windowed extension (optional)
79+
8980
This makes it easier for you to share the slides to zoom. Allows you to pop out the fullscreen view to a single window.
9081

9182
[GitHub Link](https://github.com/dralletje/Windowed)
@@ -97,6 +88,7 @@ Start a meeting in zoom (you can start and record a meeting with a single partic
9788
#### Setting up slides for recording
9889

9990
Open your slides in Presenter View
91+
10092
![Presenter View](presenterview.png)
10193

10294
It should open a presenter view, with a timer, slide notes, and change the tab from editor to a slideshow presentation
@@ -173,28 +165,25 @@ Coming soon
173165

174166
### Rename your recording
175167

176-
Rename your recording to ``YYYY-MM-DD-<Segement Name>-<gh-handle>.mp4``
168+
Rename your recording to ``YYYY-MM-DD-<Segement Name>-<gh-handle>.mp4``
177169

178-
Where
179-
* ``YYYY-MM-DD`` being date, is the date video was recorded
180-
* ``<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)
181-
* ``<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>``
170+
Where
182171

183-
For example
172+
- ``YYYY-MM-DD`` being date, is the date video was recorded
173+
- ``<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)
174+
- ``<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>``
184175

185-
``2021-05-10-why-contribute-alisondy.mp4``
186-
``2021-05-10-why-contribute-alisondy-mrbobbytables.mp4``
176+
For example
187177

188-
### Update Google Drive
178+
``2021-05-10-why-contribute-alisondy.mp4``
189179

190-
#### Uploading your video
180+
``2021-05-10-why-contribute-alisondy-mrbobbytables.mp4``
191181

192-
You will upload your recording to the folder associated with your segment. More details in [What folder to upload to](#what-folder-to-upload-to)
182+
### Uploading your video to Google Drive
193183

194-
##### What folder to upload to
195-
There should be a folder for your segment. If one doesn't exist, create a new one with the segment name.
184+
You will upload your recording to the folder associated with your segment. If the folder for your segment doesn't exist, create a new one with the segment name.
196185

197-
segment 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)
186+
The segment 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)
198187

199188
For example
200189

@@ -204,95 +193,9 @@ For example
204193

205194
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.
206195

207-
#### Upload the new video
208-
209-
In youtube, upload the same video and title it as follows
210-
211-
```txt
212-
Contributor Workshop : <Segment Name> with <Presenter Name> | <Month> <Year>
213-
```
214-
215-
For example
216-
217-
```txt
218-
Contributor Workshop : Why Contribute? with @alisondy | May 2021
219-
```
220-
221-
##### Adding the thumbnail image
222-
223-
```markdown
224-
TODO : Instructions on how to generate a thumbnail image, similar to https://gist.github.com/alisondy/e4ff3b483a32330ade0c880b4a4a10b1
225-
```
226-
227-
Set the thumbnail to the image generated in the previous step
228-
229-
##### Setting the description
230-
231-
Use the following template for setting the video description
232-
233-
```txt
234-
This is the video guide for the Contributor Workshop segment <Segment Name>
235-
236-
Link to this segments page:
237-
https://kubernetes.dev/docs/workshop/<page-name>
238-
239-
Link to the workshop:
240-
https://kubernetes.dev/docs/workshop/
241-
```
196+
> Youtube Admins see [Video Upload Guide](videouploadguide.md) for details about uploading the segment to youtube
242197
243-
#### Update the previous video for the segment if it exists
244-
245-
If you're updating an already existing video, follow the next steps to update the following on the previous video
246-
- title
247-
- thumbnail
248-
- description
249-
- comments section
250-
251-
##### Update the title
252-
Update the title on the previous video to match the following format
253-
254-
```txt
255-
Contributor Workshop : <Segment Name> | <Month> <Year> | 🚨🚨 DEPRECATED 🚨🚨
256-
```
257-
258-
For example
259-
260-
```txt
261-
Contributor Workshop : Why Contribute? with @alisondy | May 2021 | 🚨🚨 DEPRECATED 🚨🚨
262-
```
263-
264-
##### Update the thumbnail image
265-
266-
Update the Thumbnail image on the previous video to
267-
268-
insert-deprecation-thumbnail-here.jpeg
269-
```txt
270-
271-
272-
THIS VIDEO IS DEPRECATED!
273-
See the comments & description for details on where to find the new video guide!
274-
275-
276-
```
277-
278-
##### Update the Description
279-
280-
On the previous video, add the following to the start of the description
281-
```txt
282-
🚨🚨 DEPRECATED , Please see <link to new video> 🚨🚨
283-
```
284-
285-
##### Update the Comments
286-
287-
On the previous video, add the following as a comment as Kubernetes YT & pin to the top of the comments
288-
289-
```txt
290-
🚨🚨 DEPRECATED , Please see <link to new video> 🚨🚨
291-
```
292-
293-
Close the comment section of the deprecated video
294-
295-
#### Updating the Segment page with video
198+
## Update the Segment page with video
296199

297200
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.
298201

@@ -309,21 +212,22 @@ If adding to a segment page where a video already exists, update the youtube id
309212
### Video
310213

311214
#### Camera Type
312-
Use an external camera or webcam to capture your video.
215+
216+
Use an external camera or webcam to capture your video.
313217

314218
Built in webcams restrict the angle of you webcam, to the viewing angle of your display, and often provide a low quality image.
315219

316-
* 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.
317-
* Lighting - Adjusting your lighting may help you get a better camera feed in less than optimal lighting conditions.
318-
* Optimize the ambient lighting within your space first.
319-
* There should be no window or strong light source behind you that darkens your face
320-
* There should be no strong light source from one side that casts a shadow on the opposite side of your face.
321-
* Good ambient lighting from your ceiling lights or windows may be enough as long as they are in front of you.
322-
* Diffused lighting is better than harsh, direct lighting.
323-
* 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.
324-
* 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.
325-
* 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.
326-
* Video with more lighting tips [https://youtu.be/rGcAM1CNEU0](https://youtu.be/rGcAM1CNEU0)
220+
- 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.
221+
- Lighting - Adjusting your lighting may help you get a better camera feed in less than optimal lighting conditions.
222+
- Optimize the ambient lighting within your space first.
223+
- There should be no window or strong light source behind you that darkens your face
224+
- There should be no strong light source from one side that casts a shadow on the opposite side of your face.
225+
- Good ambient lighting from your ceiling lights or windows may be enough as long as they are in front of you.
226+
- Diffused lighting is better than harsh, direct lighting.
227+
- 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.
228+
- 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.
229+
- 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.
230+
- Video with more lighting tips [https://youtu.be/rGcAM1CNEU0](https://youtu.be/rGcAM1CNEU0)
327231

328232
### Audio
329233

@@ -340,33 +244,35 @@ Built in webcams restrict the angle of you webcam, to the viewing angle of your
340244
#### Sound Environment
341245

342246
##### Background Noise
247+
343248
It’s best to be in a controlled environment with little to no background noise.
344249
If this is not possible you can use your recording software and other software to remove background noise.
345250
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.
346251

347-
** Removing Background noise in Zoom**
252+
###### Removing Background noise in Zoom
348253

349254
In zoom settings under ``Audio``
350255
Change the Suppress background noise setting to ``High``
351256

352-
** Removing Background noise with Krisp**
257+
###### Removing Background noise with Krisp
353258

354259
Krisp provides AI powered background noise cancellation, see [krisp.ai](https://krisp.ai/) for more information.
355260

356-
** Removing Background noise with NVIDIA Broadcast or RTX Voice**
261+
###### Removing Background noise with NVIDIA Broadcast or RTX Voice
357262

358263
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.
359264

360265
##### Other Tips
361-
* Mute all notifications and programs not being recorded
362-
* Disable any unnecessary audio devices
266+
267+
- Mute all notifications and programs not being recorded
268+
- Disable any unnecessary audio devices
363269

364270
### Screensharing
365271

366-
* Increase the font size when sharing terminals, text editors
367-
* Ensure you have all the windows you need opened before recording.
368-
* Export any sensitive variables needed in your terminals before starting your presentation
369-
* If using a passworded ssh key, Start a ssh-agent in the terminal beforehand.
272+
- Increase the font size when sharing terminals, text editors
273+
- Ensure you have all the windows you need opened before recording.
274+
- Export any sensitive variables needed in your terminals before starting your presentation
275+
- If using a passworded ssh key, Start a ssh-agent in the terminal beforehand.
370276

371277
### Hardware
372278

@@ -384,9 +290,7 @@ Blue / Samson – i.e. Blue Snowball / Blue Yeti / Samson Meteor / Samson G-Trac
384290

385291
Good value – Logitech C920
386292

387-
388-
389-
More info – https://www.tomsguide.com/news/where-to-buy-webcams-now-these-retailers-have-stock
293+
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)
390294

391295
#### Presentation remotes
392296

0 commit comments

Comments
 (0)