dotcom900825 / goingoncall-docs

Repository for the Best Practices for On Call Teams Ops Guide

PagerDuty Best Practices for On-Call Teams Guide

This guide is a collection of resources from PagerDuty and others that is intended to help teams new to being on-call navigate the ins and outs of response.

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

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 v6.2.1 of MkDocs PyMdown Extensions. pip install pymdown-extensions==6.2.1
6. To test locally, run mkdocs serve from the project directory.

Docker Option

From the root directory of this repo...

1. docker build -t mkdocs .
2. docker run -v `pwd`:/docs/ -p 8080:8080 mkdocs
3. Open http://localhost:8080 to see changes in your browser

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/goingoncall-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.