Skip to content
PagerDuty's Public Postmortem Documentation
Branch: master
Clone or download
gmiranda23 Merge pull request #2 from PagerDuty/mattstratton-patch-1
Fix typo for “warning” -- We live in a cold world according to @mattstratton
Latest commit 76e5cdd May 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Initial Commit. Jan 29, 2019
config Initial Commit. Jan 29, 2019
docs Fix typo for “warning” May 4, 2019
theme Initial Commit. Jan 29, 2019
.gitignore Initial Commit. Jan 29, 2019
Dockerfile Initial Commit. Jan 29, 2019
LICENSE Initial Commit. Jan 29, 2019
README.md Update README.md Jan 29, 2019
mkdocs.yml Fixing header levels and images. Jan 29, 2019
screenshot.png Initial Commit. Jan 29, 2019

README.md

PagerDuty PostMortem Best Practice Documentation

Build Status

This is a collection of information about the PagerDuty postmortem process and industry best practices. This guide will teach you how to build a culture of continuous learning, the most important components to include in your analysis, and how to conduct effective postmortem meetings. See the home page for more information on what this documentation is and why it exists.

You can view the documentation directly in this repository, or rendered as a website at https://postmortems.pagerduty.com.

PagerDuty Postmortems Documentation

Development

We use MkDocs to create a static site from this repository. For local development,

  1. Install v0.1.0 of MkDocs Bootswatch pip install mkdocs-bootswatch==0.1.0
  2. Install v0.1.1 of MkDocs Bootstrap pip install mkdocs-bootstrap==0.1.1
  3. Install v0.15.3 of MkDocs. pip install mkdocs==0.15.3
  4. Install v0.2.4 of the MkDocs Material theme. pip install mkdocs-material==0.2.4
  5. Install MkDocs PyMdown Extensions. pip install pymdown-extensions
  6. To test locally, run mkdocs serve from the project directory.

Docker Option

  1. docker build -t mkdocs .
  2. docker run -p 8080:8080 mkdocs

Deploying

  1. Run mkdocs build --clean to produce the static site for upload.

  2. Upload the site directory to S3 (or wherever you would like it to be hosted).

     aws s3 sync ./site/ s3://[BUCKET_NAME] \
       --acl public-read \
       --exclude "*.py*" \
       --delete
    

License

Apache 2 (See LICENSE file)

Contributing

Thank you for considering contributing! If you have any questions, just ask - or submit your issue or pull request anyway. The worst that can happen is we'll politely ask you to change something. We appreciate all friendly contributions.

Here is our preferred process for submitting a pull request,

  1. Fork it ( https://github.com/PagerDuty/postmortem-docs/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request.
You can’t perform that action at this time.