This is a public version of the Incident Response process used at PagerDuty. It is also used to prepare new employees for on-call responsibilities, and provides information not only on preparing for an incident, but also what to do during and after. See the about 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://response.pagerduty.com.
We use MkDocs to create a static site from this repository.
For local development on your native device,
pip install mkdocs
pip install pymdown-extensions
pip install pygments
git clone https://github.com/pagerduty/mkdocs-theme-pagerduty
cd mkdocs-theme-pagerduty & python3 setup.py install
mkdocs serve
from the project directory.http://127.0.0.1:8000
. The site will automatically update as you edit the code.For local development using Docker,
docker build --load -t mkdocs .
docker run -v $(pwd):/docs -p 127.0.0.1:8000:8000 mkdocs
http://127.0.0.1:8000
. The site will automatically update as you edit the code.Note: If you're using an Apple Silicon device, add --platform linux/arm64/v8
to the docker build
command to get a native Apple Silicon image. That will work faster than translating an arm64 image.
mkdocs build --clean
to produce the static site for upload.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
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,
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)