Skip to content

Reference, Content Types

Joe Moore edited this page Dec 20, 2021 · 4 revisions

This page details the different content types posted on the Tanzu Developer Center. Use this reference if you are trying to decide what template to start with, or what to submit your content as. If you have questions about this, open a GitHub issue or ask the team in the #tanzu-developer-center Slack channel (VMware Employees only).

Guides

  • Guides are typically prescriptive learning paths.
  • Often include a series of steps to write a program or deploy a tool.
  • There are a couple taxonomies for guides. These are a "What Is...?" or a "Getting Started" guide.
  • Guides are also typically “evergreen” content, or content that isn’t frequently changing.
  • Guides should educate the reader by introducing a goal and teaching the reader how to accomplish it.
  • They are written in a “teacher tone”. they are more formal and to the point.

Blog Posts

  • Blog posts are typically informative, and timely.
  • Product announcements, or “thought leadership” posts often fall into this category.
  • Can be opinionated and have a casual tone.
  • More flexible with content; can be time-specific.
  • Conversational. “I” and “we” instead of just “you”.

Code Samples

  • Code samples are often used in conjunction with guides or blog posts, and are used to provide a static representation of code at the time it was written.
  • Demos a feature, method, or technology.
  • Documented both in code and the README.
  • Can be run by the reader (just as guides are actionable, code samples are also.)

Videos

  • These are markdown formatted video templates to provide some context around your video hosted on the Tanzu Developer Center.
  • Your video should be uploaded to the VMwareTanzu YouTube channel first.
  • A technical demo, or a code walkthrough
  • Teaches, does not sell.

Workshops

  • Provides a hands-on demonstration that the user can learn at their own pace.
  • Slightly more flexible on the “OSS, free(mium), trial” benchmark.
  • Completely self-contained. Does not require the user to download, run, or configure something outside the workshop.

Agile Practice (VMware Employees Only)

  • Practices are typically written by the VMware Tanzu Labs team (VMware Employees), and are typically around the practices that Tanzu Labs facilitates.
  • If you are interested in creating a Practices post, review the Tanzu Practices Contrition Guide for detailed instructions and engage with that team in the #tanzu-developer-center Slack channel (VMware Employees Only).
Clone this wiki locally