search

usagov / test-at-home

Other
8 stars 4 forks source link

Initial run book #293

Closed rahearn closed 2 years ago

rahearn commented 2 years ago

Adds run book covering the common "bring site down" "bring site up" and "switch active configuration" scripts.

Will add merge and deploy instructions in another PR.

283

kbighorse commented 2 years ago

2 more general comments:

  1. Possibly consolidate repeated text somehow, easy to imagine updating one section when it really affects multiple.
  2. Number the steps, currently all say # 1

Otherwise, LGTM 👍🏾

mitchellhenke commented 2 years ago

2. Number the steps, currently all say # 1

This is a Markdown shorthand, they'll get rendered as ascending numbers 🙂

rahearn commented 2 years ago
  1. Possibly consolidate repeated text somehow, easy to imagine updating one section when it really affects multiple.

I want to talk about this some more. Right now, they're duplicative (except the one part where I didn't want copies of screenshots) so that when you are following the instructions for one section it is self-contained. That felt like a win vs the pain of having to be more careful when updating.

Thoughts on that?

mitchellhenke commented 2 years ago
  1. Possibly consolidate repeated text somehow, easy to imagine updating one section when it really affects multiple.

I want to talk about this some more. Right now, they're duplicative (except the one part where I didn't want copies of screenshots) so that when you are following the instructions for one section it is self-contained. That felt like a win vs the pain of having to be more careful when updating.

Thoughts on that?

I'd agree with that, runbooks should be able to stand mostly on their own. If it's significant set of instructions that gets repeated, it could be a separate section that gets linked out to.