Skip to content

Repository files navigation

NeatContext SRE

This repository is the working knowledge base for the NeatContext SRE team. It captures real incidents handled by the team, along with the operational context, troubleshooting guidance, runbooks, communications, and postmortem materials that make those incidents useful for future response.

The team uses NeatContext to organize and analyze incident evidence. The repository is also an example for NeatContext users who want a practical reference for structuring an incident-focused knowledge base.

Repository layout

  • knowledge/ — curated incident-response knowledge, including runbooks, troubleshooting guides, architecture notes, communications, and postmortem templates.
  • profiles/ — NeatContext profiles that define how the knowledge is used.
  • extensions/ — focused NeatContext extensions for retrieving operational evidence and supporting analysis.
  • library.json — NeatContext library metadata.

Working with the repository

  1. Add durable incident knowledge to the appropriate folder under knowledge/.
  2. Keep facts, evidence, hypotheses, mitigations, and follow-up actions distinguishable.
  3. Use NeatContext with the relevant profile to analyze an incident and turn the useful outcome into reusable guidance.
  4. Submit changes through a pull request for collaborator/code-owner review.

Do not commit secrets or sensitive incident data. See AGENTS.md for the repository contribution rules.

About

NeatContext SRE team's oncall assets. This also demonstrate how to use NeatContext to handle real incidents

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages