title: Sample Runbook
summary: |
This runbook is just a sample to demonstrate how to format the source in YAML.
It is not meant to perform any actions. This is really just a sample. Any text
block can formatted as *Markdown*.
note: |
You can use the `$(...)` syntax to reference variables in any text block within
the runbook. The file `default.yml` will be included within each runbook as it
processed.
author: Enter Team Name
contact: team@domain.com
steps:
- name: First Step
summary: |
This steps does nothing but it is the first. Remember, this is a sample
runbook and is designed to accomoplish nothing.
note: Notes can be added but are not required.
- name: Variables
summary: |
This runbook references the `$(Team)` and `$(Email)` variables. The
variables can be defined in the `default.yml` file contained in the root
directory in addition to the command line.
- name: Mardkdown
summary: |
All runbook YAML source files compile to Markdown files for reading. This
is the first step for readability. This functionality is included in the
compiler by default.