Icon

Creating your first runbook

This guide will help you create your first runbook in Transposit. A runbook in Transposit includes written documentation and interactive actions. All runbooks in Transposit are written in Markdown and backed by git.

Creating your first runbook

  1. In the left navigation, go to the Runbooks section.
  2. Click the New runbook button.
  3. Your new runbook will be populated with some useful Markdown text to guide you. Your Markdown first-level heading (#) is your runbook header and title, so go ahead and give that a new, descriptive name like "First runbook."
  4. Select Add action and choose Create new action.
  5. Our first action is going to output "Hello world," so name the first action: Hello World. Select Choose workflow and search for the "Hello World" workflow to select.
  6. Navigate to the activity channel in Slack where you've set up Transposit and run the /transposit command to get bring up the runbooks modal.
  7. Select your First Runbook and run your Hello World action.
  8. Your action should now output "Hello World" to Slack and your timeline.

Where to go from here?

Now that you've created your first runbook, you can expand on it. Transposit has a pre-built set of workflows that you can create actions 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 that fits your needs, check out how to create your first workflow.

Happy runbooking!