Skip to content

docs(incident-management): normalize structure and wording - #586

Open
mattaereal wants to merge 6 commits into
developfrom
docs/normalize-incident-management
Open

docs(incident-management): normalize structure and wording#586
mattaereal wants to merge 6 commits into
developfrom
docs/normalize-incident-management

Conversation

@mattaereal

Copy link
Copy Markdown
Collaborator

Scope

Normalize content chrome for docs/pages/incident-management/** only (SEAL frameworks content model). No other frameworks.

Why

Align Incident Management pages with canonical Key Takeaway format, contributor roles, nested overview page maps, footer separators, and absolute internal links—matching prior framework normalize PRs.

Content model applied

  • Canonical > 🔑 **Key Takeaway**: (colon outside bold) from existing page substance
  • Frontmatter contributors with wrote / reviewed / fact-checked (preserve usernames; empty arrays OK)
  • Brief intro after KT when page previously jumped straight to ##
  • Nested overviews get sidebar-aligned page maps with absolute links
  • --- before <ContributeFooter />
  • Prefer absolute internal links when links were touched
  • Do not edit generated index.mdx

Changes

  • Framework overview page map (already drafted): top-level pages, playbooks, IR template/templates/runbooks hubs
  • Nested overviews: playbooks, IR template, templates hub, runbooks hub—child lists + absolute links
  • Leaf pages across playbooks, policy/roles/comms/contacts, templates, and runbooks: KT + chrome only
  • Relative internal links converted to absolute where chrome touched; MD013 wraps applied

Substantive security guidance changes

None. Procedures, checklists, runbook steps, and template bodies preserved.

Intentionally unchanged

  • Generated index.mdx files
  • Other frameworks
  • .mailmap
  • Security procedure content (not rewritten)
  • Forensic Readiness body (already had KT/chrome; no substantive chrome delta vs base)

Validation

npx --yes markdownlint-cli2 "docs/pages/incident-management/**/*.mdx"  # 0 issues
pnpm exec cspell --no-progress "docs/pages/incident-management/**/*.mdx"  # 0 issues

Dependencies

Depends on content-model direction from #561 by reference only (no hard merge block intended beyond develop base).

Reviewer focus

  • Key Takeaways accurate to page substance (no invented guidance)
  • Nested page maps match vocs.config.ts sidebar children
  • Absolute links correct
  • No accidental procedure body rewrites
  • Authors preserved in contributors

Add canonical Key Takeaways, contributor fact-checked roles, nested page
maps, absolute internal links where chrome was touched, and ContributeFooter
separators. Preserve procedure and checklist bodies.
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 27, 2026

Copy link
Copy Markdown

Deploying frameworks with  Cloudflare Pages  Cloudflare Pages

Latest commit: 45b8255
Status: ✅  Deploy successful!
Preview URL: https://f1a60db9.frameworks-573.pages.dev
Branch Preview URL: https://docs-normalize-incident-mana.frameworks-573.pages.dev

View logs

Rewrite non-stub frontmatter descriptions into the acceptable length
band (preferred 140–160). Stub pages exempt. No body or credit changes.
Rename Further Reading H2s to the exact title the updated #561 validator accepts; sentence-case a few common section headings.
Child pages missing a canonical further/related H2 failed the updated #561 validator. Add a minimal Further Reading block linking the framework overview.
Neutralize fence comments that look like headings, canonicalize overview page-map titles, clamp descriptions, demote excess H2s, and mark template pages with content-model exceptions.
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

Successfully merging this pull request may close these issues.

1 participant