incident-management: tighten IR template structure and pipeline runbook#424
Conversation
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Second pass updateThis second pass keeps the same philosophy as the first one:
What changed in this pass This pass focuses on the two runbooks that still felt materially underpowered:
1) Strengthened frontend-compromiseThis page now better reflects how frontend incidents actually behave in practice, especially in Web3 where a frontend compromise often becomes a user-signing or Changes include:
The goal here was to make the page more useful during the first minutes of an actual incident, not just more complete on paper. 2) Strengthened dependency-attackThis page was still too close to a stub. It now better distinguishes between a generic vulnerable package and a dependency incident that may have affected real build Changes include:
What I intentionally did not change Still intentionally out of scope:
For example, I left key-compromise unchanged in this pass rather than make lower-confidence edits. Why this is the last pass At this point, the highest-value weak spots in the imported IR template section have been addressed without turning the PR into a broad rewrite. This keeps the contribution focused on:
|
|
Left some comments @mattaereal |
9d348ab to
d8165b7
Compare
|
@frameworks-volunteer can you address @scode2277's comments, solving the conversation and potential conflicts? Take all her feedback seriously. |
d8165b7 to
43f0e45
Compare
|
Model: Addressed all of @scode2277 feedback and resolved merge conflicts with develop. Here is what was done:
|
scode2277
left a comment
There was a problem hiding this comment.
gtg for me @mattaereal!
frameworks-volunteer
left a comment
There was a problem hiding this comment.
Model: moonshotai/kimi-k2.6 Reasoning: high Provider: openrouter
Security: clean. No secrets, injection vectors, or unsafe patterns. Content is MDX docs only.
QA: all checks pass.
- CI green (build, lint, sidebar-reminder)
- All internal link targets exist and resolve correctly
- Frontmatter valid and consistent across files
- No leftover debug content, TODOs, or placeholder text
- "Stub runbook" language properly replaced with "Example runbook"
Substantive notes:
-
Build pipeline compromise runbook: major upgrade from thin stub to credible operational document. The addition of scope questions, differentiation from adjacent incident classes, evidence preservation, blast-radius-ordered credential rotation, and a verification gate before resuming delivery are all well-chosen. The three recovery options (rebuild / rollback / pause) with explicit "When" and "Impact" framing is practical.
-
Dependency attack runbook: similarly upgraded with proper scope questions, differentiation (correctly cross-linking to build-pipeline-compromise and frontend-compromise), and a "Verification Before Resuming" gate. Good that it distinguishes malicious vs vulnerable packages.
-
Frontend compromise runbook: tightened throughout. The user warning message template is improved ("If you have not signed new transactions, your funds in the protocol remain unaffected" adds important clarity). Evidence preservation moved before cleanup is the right call. The trust boundary failure step is a useful addition.
-
Taxonomy clarifications across overview pages are concise and well-placed -- they give readers a mental model for framework guidance vs templates vs runbooks vs playbooks without being repetitive.
-
Policy/staffing softening ("Monitor based on residual risk..." and "24/7 escalation path") are more realistic and less doctrinal. Good changes.
-
One minor note: templates/overview.mdx line "use a template" self-links to the current page. Not broken, but slightly odd for a directory page. Very low priority.
Approving -- this is a solid, well-scoped first pass that delivers exactly what it promises.
Summary
This PR is a first pass on the recently added Incident Response Template section.
The goal is not to expand the section broadly, but to make it clearer, tighter, and more operationally credible without adding filler or speculative content.
This pass focuses on three things:
What changed
1) Clarified content taxonomy
Added concise framing so readers can understand what each layer is for:
2) Tightened a few absolute statements
These changes are meant to make the guidance more realistic and less doctrinal.
3) Upgraded the build pipeline compromise runbook
incident-response-template/runbooks/build-pipeline-compromise.mdx was previously a thin stub. This PR upgrades it into a more credible example runbook by adding:
What this PR does not do
Intentionally out of scope for this first pass:
I would rather leave gaps visible than fill them with weak or speculative guidance.
Why this scope
The Incident Response Template addition is already valuable, but right now it mixes:
This first pass tries to make that structure easier to understand, while also strengthening one page that felt materially underdeveloped.
Follow-up ideas (not included here)
Possible future passes, if useful: