artsy / README

:wave: - The documentation for being an Artsy Engineer
Creative Commons Attribution 4.0 International
1.1k stars 120 forks source link

Collapse incident-handling as much as possible into single, linear doc #419

Closed joeyAghion closed 2 years ago

joeyAghion commented 3 years ago

Our documentation of incident-handling procedures and tools have proliferated and it's been difficult to keep them up-to-date with evolving tools and conventions. This [work-in-progress] update attempts to consolidate them into a single doc. It doesn't yet remove the pre-existing docs.

For instructions that are occasionally relevant, but shouldn't get in the way of an on-call engineer who may be under pressure to respond to an incident, I employ the <details><summary>... syntax to keep that content collapsed by default.

(Some of the unrelated edits and questionable whitespace choices are required by the pre-commit hook, not me.)

joeyAghion commented 2 years ago

Thanks for all the feedback. I'll merge, noting these areas of possible improvement: