Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Analyst sees consistently-formatted runbooks #3466

Open
ohrite opened this issue Sep 19, 2024 · 0 comments
Open

Analyst sees consistently-formatted runbooks #3466

ohrite opened this issue Sep 19, 2024 · 0 comments

Comments

@ohrite
Copy link
Contributor

ohrite commented Sep 19, 2024

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant