PagerDuty's public operational review documentation.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
config
docs
theme
.gitignore
LICENSE
README.md
mkdocs.yml
screenshot.png

README.md

PagerDuty Operational Review Documentation Build Status

This is a public version of the Operational Review framework that PagerDuty is adapting and implementing internally. It is used to ensure that PagerDuty leadership is aligned on the impact that real-time, digital operations have on our business outcomes. See the About page for more information.

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

Operational Reviews

Development Info

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

  1. Install v0.1.1 of MKDocs Bootstrap pip install mkdocs-bootstrap==0.1.1
  2. Install v0.1.0 of MkDocs Bootswatch themepip install mkdocs-bootswatch==0.1.0
  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. To test locally, run mkdocs serve from the project directory.

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/operational-review-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.