This guide will help you create your first runbook in Transposit. A runbook in Transposit includes written documentation and interactive workflows. All runbooks in Transposit are written in Markdown and backed by git.
#
) is your runbook header and title, so go ahead and give that a new, descriptive name like "First runbook."/transposit
command to get bring up the runbooks modal.Now that you've created your first runbook, you can expand on it. Transposit has a pre-built set of workflow applications that you can create workflows with and add to create actionable, multi-step runbooks.
Runbook steps are defined by second-level headings (##
). Text following a second-level heading describes and contains information about a runbook step. Steps do not need to be followed linearly. Some runbooks might use steps as non-linear sections of a runbook. The runbook's table of contents is made up of each of the runbook's steps. To divide information within a step, you can use a third-level heading (###
).
If you don't see a workflow application that fits your needs, check out how to create your first workflow.
Happy runbooking!