Reviewer

Review 101

Video training content goes stale. egghead.io should be as up to date as possible when it comes to content. Because of the nature of video we need to monitor each lesson on multiple levels.


Lesson Video

An excellent coding screencast will focus on core concepts and have the ability to remain “evergreen” through minor revisions of the library that it is demonstrating. We need to continue to monitor this to make sure that it is the case.

When differences exist we can take several courses of action:

  • update the code sample and use comments in the code to notify the user that it has changed from the video
  • Annotate the lesson’s page to tell the student what is wrong with the lesson
  • Replace the lesson video/code with an updated version
  • mark the lesson as obsolete/deprecated
  • record a new version (vs replacement)

Update Lesson Code Sample

This is the most common action taken by the reviewer. The lesson code sample should reflect the current version(s) for the libraries it is demonstrating (libraries are updated often!). The sample code can correct for minor differences in the code demonstrated in the lesson video, noting with comments when this has been done.

Annotate the lesson page

When there is some significant breaking difference in the lesson video and code sample, we can create a notification to be displayed prominently on the lesson page. This notification comes in the form of an errata which is shown below:

Errata Example

Replace the lesson video/code

If the lesson still has significant value conceptually, we can re-record the lesson and produce an updated code sample. We want to do this for popular lessons and maintain our SEO.

Make a note of why you think the lesson needs to be re-recorded in the review document.

Mark as obsolete

Like Annotation above, but more deadly! :skull:

Record a new lesson

Sometimes we will want to record a new lesson that presents the underlying concept with the updated version instead of replacing it in-place

Quick Install (Mac)

Open up your terminal paste in the following and then press return to install Homebrew: /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Afterwards you're going to run each of the following in your terminal:

  • Google Chrome: brew cask google-chrome
  • Slack: brew cask install slack
  • GitKraken: brew cask install gitkraken
  • Visual Studio Code: brew cask install visual-studio-code
  • Yarn: brew install yarn