kube-academy/onboarding

Repository for documenting the onboarding process for new contributors to https://kube.academy/

onboarding's Issues

video hosting procedure

Overview

Videos are all hosted on Vimeo for the following reasons:

• No ads
• Can hide the branding (no vimeo logos)
• Can hide from showing up in the vimeo.com platform (searches, etc)
• Allows whitelisting of domains

The same vimeo account is used for staging vs. production.

Upload

• Need to be added to VMware Cloud Native Education team/group in Vimeo
• From the top left select the above mentioned group
• If new course, make a folder in the videos section. Name the folder the same as the github repo for the course
• Upload the video the folder just created

Settings

While the video is uploading, got to the advanced settings for the video:

• Title - set lesson number and lesson name
• Privacy
  • Hide from vimeo
  • Specific domains
    • kube.academy
    • fixeldev.com
  • No one can comment
  • Disable download
  • Disable add to collections

Sample Recording - Ryan Schneider

Here is a link to my sample video that illustrates my audio/video setup.

https://drive.google.com/file/d/1sSJ4qFWrvjG1034DH1SLX__i0zJDcuHV/view?usp=sharing

produce course creation guide and tips

Overview

As people start to contribute and make courses, workshops, or both it would beneficial to guide and help people with the best practices and guidelines around course creation. The onboarding effort is more focused around logistical items (accounts, access, process, recording settings, etc) where this will focus on the curriculum/content and presentation.

Potential Guides

Lesson Content

• Slide creation and graphics
• Outlines and narratives
• Incrementally reveal information
• Explain vs demo vs link to docs

Presentation

• Physical - stand, where to look, etc.
• How to tell a story
• Best practices for recording if its your first time

Labs

• What to include vs not
• Prescriptive vs Objective based labs
• When to make someone type or figure it out vs run scripts
• fast forwarding and connected labs

document features and functionality of KubeAcademy

The idea here is to explain to contributors or folks in general what are the features and functionality of KubeAcademy platform itself (content agnostic).

Create Sitemap

Let's put together a draft site map for the onboarding repo.

Example:
Proposed Outline:

README.md

• How would you like to contribute?
  • Report and fix issues
  • Enhance existing courses
  • Create new courses or lessons
• Video Recording Guide
• Lab Creation Guide