ghoelzer-aws / containers-quickstarts

PaaS & Containers CoP Application Demo Libarary

Container Quickstarts by Red Hat's Community of Practice

This repository is meant to help bootstrap users of the OpenShift Container Platform to get started in building and using Source-to-Image to build applications to run in OpenShift.

Structure of a QuickStart

• Overview
  • README discussing what this demo does
• Bill Of Materials
  • Environment Specs -- describe the environment required to run this demo
  • Template files
  • Config files
  • External Source Code repos
  • etc. (any other technical collateral needed to run your demo)
• Setup Instructions
  • Describe the steps required to setup your Demo
  • Scripts to run
  • Terminal commands
  • etc.
• Presenter Notes
  • Guidelines for "what to {type|click|do}" to walk through the demo
  • Guidelines for "what to say" while giving the demo (level of detail will vary depending on the audience and intended presenter)
  • Interesting concepts, anecdotes to point out along the way

Quickstart Model Example

For a good example of what a quickstart should look like, see the S2I Play directory.