Public incident reports for 2i2c managed cloud infrastructure.
This site documents 2i2c's engineering team incidents, their resolutions, and what we learned.
🔗 View the site: https://2i2c-org.github.io/incident-reports/
- Transparency: Share what goes wrong and how we fix it
- Learning: Document lessons learned from each incident
- Accountability: Public record of our service reliability
- Knowledge sharing: Help others learn from our experiences
- Export PDF from PagerDuty
- Add to
reports/folder - Commit and push
GitHub Actions automatically converts the PDF and deploys the updated site using docling
nox -s docs-liveThis repository roughly follows a 3-step process:
- Parse PDFs in
reports/ - Convert them to markdown using docling
- Parse the markdown for metadata with hacky regexes (e.g. "duration")
- Output MyST markdown to be parsed by the MyST site in
docs/
GitHub Actions automates all of the above any time we change the repository.
Note: There is some hacky logic that parses the PDFs and extracts standardized metadata from it. I did my best to figure out the proper regexes, but this is likely brittle and will break if we change the format of our incident reports...it'll probably miss some stuff too.
- The Product and Services team is responsible for the content in
reports/, and for adding new ones to this repository. - The Marketing team is responsible for the code and infrastructure that generates a MyST site from these PDFs.