Skip to content
This repository has been archived by the owner on Jan 17, 2023. It is now read-only.

Latest commit

 

History

History
280 lines (182 loc) · 10.7 KB

README.md

File metadata and controls

280 lines (182 loc) · 10.7 KB
Raw

TGIK Documentation

This will mostly be internal, but sharing broadly as a resource.

Creating the Checklist

Start by copying the following into the issue for the episode. Check things off as you do them.

The process for producing an episode is [here](https://github.com/vmware-tanzu/tgik/blob/master/documentation/README.md).  All the detail for the steps below is there.

Monday or Tuesday:
* [ ] Pick a topic and create/use an issue in the repo
* [ ] If applicable coordinate with an upstream project if they're interested in attending the show
* [ ] Create the graphic
* [ ] Schedule on Youtube
* [ ] Add scheduled episode to TGIK playlist on YT
* [ ] Create short link in rebrandly
* [ ] Tweet about it from your personal account
  * [ ] Post tweets on internal #tgik slack channel and cc  Vykky

Before episode:
* [ ] Create HackMD page for live notes.  Start with README template in this repo
* Show Coordination with Assistant (if you have one)
  * [ ] Paste HackMD URL on internal #tgik channel
  * [ ] Assistant adds ~5-10 news items from around the web as possible "News of the Week"
  * [ ] Confirm show time and AV check 
  * [ ] Last minute retweets or topic updates
  * [ ] Sync with external guest one last time if necessary
* [ ] Get everything tested well before episode so you can debug
* [ ] Use internal slack channel to ensure that AV se tup is good

After show (ideally right away but can wait until Monday):
* Create/submit PR for this repo
  * [ ] Episode directory and README from hackmd
  * [ ] Any other files from the episode that might be useful
  * [ ] Update playlist.md with episode
  * Feel free to self merge
* [ ] Edit YT description to point to episode directory here
* [ ] OBS/OS Upgrade if applicable (Never on the day of a show)

Creating the graphic

Find an image to use that is fun and subtly hints at the topic for the episode. For example episode 38 was on Kata containers, and the supporting image was of containers in a shipyard.

You will need the Ubuntu Bold font if you don't have it already.

Adobe Illustrator (Mac/Windows):

  1. Open graphics/title-card.ai with Adobe Illustrator.
  2. Delete the old image and use the "File | Place" to insert the new image. Move that to the back with "Object | Arrange | Send to Back".
  3. Select the semi-transparent background on the text and the logo box and use the eye dropper tool to pick a light color out of the image.
  4. Export to PNG in the same folder using "File | Export | Export for screens"
  • Before saving make sure you change the name of the artboard (which determines the filename) by double clicking it on that dialog.
  • Export as PNG at 1x

Inkscape (Linux/Mac/Windows):

  1. Open graphics/title-card.svg with inkscape.

    inkscape graphics/title-card.svg

  2. Open the layers panel (ctrl+shift+L).

  3. Select the background image (ensure Background layer is selected).

  4. Right click on the background image.

  5. Choose Release Clip.

    This reveals two objects in the layer Background. The background image, which you'll replace, and a semi-transparent box representing the 1280x720 area to trim a background image to.

  6. Delete the existing background image.

  7. Paste in a new background image.

    • We often use unsplash.com; If not unsplash, ensure we have rights to use the image.

  8. Move the new background image object behind the semi-transparent box

    • PgDn or Menu Bar > Object > Lower to Bottom

  9. Move/Scale the background image around to fit desirably in the semi-transparent box.

  10. Select the background image and semi-transparent box.

  11. Right click and Set Clip.

  12. Use the Text Tool (T) to update the episode number (Ep 120 -> Ep 121).

  13. Select all semi-transparent elements (text + vmware/k8s background)

  14. Set their color by using the dropper (D) and clicking somewhere in the image.

  15. Export using Menu bar > File > Export PNG Image.

  16. Save to episodes/${EPISODE_NUMBER}/tgik${EPISODE_NUMBER}.png.

Scheduling on YouTube

  1. Ensure you're logged in to the correct Youtube Account (The VMware organization has a youtube account you need to join, and use, by clicking on the upper right corner of the youtube screen, and then logging in as VMWare Cloud Native Apps.

  2. Create a new live event by clicking here.

    • Alternatively: Youtube Studio > Create Button (top right) > Go Live.

  3. Choose a recent episode and Reuse Settings.

    This dialog pops up immediately when clicking the link above.

  4. Set the Name, Description, Time (adjust to land in 1PM PT, and use the official TGIK Thumbnail you made earlier)

  5. Store the stream key for later use (in OBS for stream settings).

  6. Pop out the chat (to get the video id URL, for OBS)...

  7. ... Now store the video id from the chat url for later use (in OBS for chat).

Updating the TGIK Playlist

Once the event is scheduled, you should add the video to the TGIK playlist so that it shows up at tgik.io.

You can do this from the YouTube Studio UI by selecting "Edit" in the upper right:

And then selecting TGI Kubernetes from the "Playlists" menu.

Alternatively, you can do this via the Scheduled Videos section:

  1. Navigate to scheduled live videos.

  2. Click the title card for your episode.

  3. Add the episode to the TGIK playlist.

  4. Verify the episode shows up at tgik.io.

Creating the Hackmd

  1. Navigate to Hackmd.

    Create an account if necessary.

  2. Import a new note from GitHub.

  3. Import from our existing template

    This may require you to give Hackmd access to your GitHub.

    • Repo: vmware-tanzu/tgik
    • Branch: master
    • File: documentation/template.md

  4. Apply all changes.

  5. Set the video id found in the Scheduling on Youtube section.

  6. Update the Hackmd content as desired.

Creating the links

Log into Rebrandly and create a new link pointing to the YouTube live stream. If you don't have Rebrandly access, reach out for help in [our internal] #tgik channel.

Create Permanent Episode Link

tgik.io/001 -> youtube.com/watch?v=ixs1-UnWiGU

Update Live Pointer

tgik.io/live -> tgik.io/tgik001

Update Hackmd Pointer

Make sure to use the ?view parameter so that folks come to the presented notes by default

tgik.io/notes -> https://hackmd.io/pAPM_qtlTIaCpYZQNF8Y6A?view

Tweeting the Episode

  • Tweet out announcing the episode with the hashtag #TGIK8s
  • Include the permanent rebrandly URL generated above
  • Include the image created above
  • Inform the appropriate humans in the [internal] #tgik channel

Setup OBS

If you don't already have an OBS configuration for TGIK:

  1. Import the OBS profile from the repository.

    • Profile > Import choose obs-config/profiles/TGIK.
    • Scene Collection > Import choose obs-config/scenes/tgik-macos.json.

  2. After importing check the Profile and Scene Collection menus to ensure TGIK is set.

  3. Further configure the scenes to hook up your mic, screen, and webcam.

    Note: Configuring and tuning OBS is an exercise in itself. If you're a first-time OBS user, consider reaching out to someone in the [internal] #tgik channel to get a walkthrough.

Preparing OBS for Stream:

  1. Open File > Settings > Stream.

  2. Paste the stream key found in the Scheduling on Youtube section.

  3. Open the YouTube chat source in your scenes.

  4. Set the video id found in the Scheduling on Youtube section.

  5. Set the title card source to the graphic made in the Creating the Graphic.

Testing the Stream

Once OBS is configured, you should verify stream quality to YouTube is good. It's important to test this with another at least an hour before you go live on Friday. What follows can be done to self-test well before Friday.

  1. Open YouTube Studio.

  2. Navigate to Videos.

  3. Click the Live tab.

  4. Open the Live Control Room for your upcoming stream.

  5. Start the stream in OBS.

  6. Verify:

    • Connection is excellent
    • Test chat message comes through to OBS

Starting the Stream

  1. Follow the steps in Testing the Stream above.

  2. Click Go Live in the Live Control Room.

  3. Break a leg!

Wrapping Up

  1. Stop the stream in OBS and YouTube.
  2. Update the Hackmd with table of contents and other relevant links.
  3. Add the hackmd to your episode folder in git.
  4. Add any relevant files to your episode folder in git.
  5. Create a merge request and merge the episode into GitHub.
  6. Update the YouTube description with table of contents and link to GitHub.