Skip to content

Front Matter Tags for Videos

anthonyvetter edited this page Oct 5, 2021 · 6 revisions

The document to include videos on the Dev Center is only front matter. Many of the keys are shared with guides and blogs, with the addition of the youtube_id key. Example.

Example with descriptions

title: # (required) (string) (default: "") The title of the video. Displays automatically at the top of the page. For optimal SEO, the title should be 50 characters, or less.
description: # (required) (string) (default: "") A description of the video. For optimal SEO, it is recommended that the description be 150 characters, or less.
date: # (required) (string) (default: doc created date) The publish date of the blog post. If this date is in the future, the blog post won't appear on the Dev Center until that date is reached.
level1: # (required) (string) (default: "") The top-level topic the post should be organized under. 
level2: # (required) (string) (default: "") The second-level topic the post should be organized under. 
tags: # (required) (string array) (default "") One or more tags to attach to the video. Useful for both search results and grouping similar content.
team: # (required) (string array) (default "") A list of authors/presenters by name. Author names are displayed under the title, and links to a Bio page if one exists with a matching name.
youtube_id: # (required) (string) (default: "") The ID of the YouTube video. For example, if the link to the video is https://www.youtube.com/watch?v=9HsWsoDd1fM, then the ID is “9HsWsoDd1fM”.

Example with example content

title: A demo of AppliKation
description: AppliKation brings Kubernetes-native applications to Kubernetes. Intrigued? Watch and find out more!
date: '2021-09-14'
level1: Deploying Modern Applications
level2: Packaging and Publishing
tags: 
- CI-CD
- Kubernetes
team:
- Jane Doe
- John Doe
youtube_id: “9HsWsoDd1fM”.

References

  • Topic Levels - Check here for level1 and level2 topics. These must be entered exactly as shown.
  • Tags - Tags are more free form than topics, but should still adhere to some patterns.
Clone this wiki locally