data-infra icon indicating copy to clipboard operation
data-infra copied to clipboard

Analyst sees consistently-formatted runbooks

Open ohrite opened this issue 5 months ago • 0 comments

User story / feature request

As an Analyst reviewing any runbook in the cal-itp/data-infra repo, When I am reading the runbook I see that it is formatted consistent with other runbooks, So that I can quickly determine what I need to do next and how

Acceptance Criteria

  1. Open any runbook in runbooks/workflow
  2. See that the file contains, at a minimum, a concise description of the purpose, sequentially-numbered steps to accomplish a task, and salient details about testing the outcome, consistent with the Diátaxis how-to guide approach of writing a recipe.
  3. Ensure that any code or shell scripts are block-quoted with ```-style Markdown blocks to enable copy-paste

ohrite avatar Sep 19 '24 18:09 ohrite