• Stars
    star
    1,020
  • Rank 45,113 (Top 0.9 %)
  • Language
    Dockerfile
  • License
    Apache License 2.0
  • Created about 8 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

PagerDuty's Incident Response Documentation.

PagerDuty Incident Response Documentation

Netlify Status

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.

PagerDuty Incident Response Documentation

Development

We use MkDocs to create a static site from this repository.

Native

For local development on your native device,

  1. Install MkDocs. pip install mkdocs
  2. Install MkDocs PyMdown Extensions. pip install pymdown-extensions
  3. Install Pygments if you want syntax highlighting for any code examples. pip install pygments
  4. Install the PagerDuty MkDocs Theme.
    1. git clone https://github.com/pagerduty/mkdocs-theme-pagerduty
    2. cd mkdocs-theme-pagerduty & python3 setup.py install
  5. To test locally, run mkdocs serve from the project directory.
  6. You can now view the website in your browser at http://127.0.0.1:8000. The site will automatically update as you edit the code.

Docker

For local development using Docker,

  1. Build the docker image and load it for immediate use. docker build --load -t mkdocs .
  2. Run the container and pass through your current working directory. docker run -v $(pwd):/docs -p 127.0.0.1:8000:8000 mkdocs
  3. You can now view the website in your browser at 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.

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/incident-response-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.

More Repositories

1

security-training

Public version of PagerDuty's employee security training courses.
Shell
409
star
2

go-pagerduty

go client library for PagerDuty v2 API
Go
287
star
3

scheduler

A Scala library for scheduling arbitrary code to run at an arbitrary time.
Scala
214
star
4

terraform-provider-pagerduty

Terraform PagerDuty provider
Go
203
star
5

blender

A modular orchestration engine
Ruby
183
star
6

pdpyras

Low-level PagerDuty REST/Events API client for Python
Python
131
star
7

pd-oncall-chat-topic

AWS Lambda Function that updates a Chat Room topic (eg, Slack)
Python
86
star
8

public-support-scripts

Python
85
star
9

pagerduty-api-python-client

A python client for PagerDuty's API, v2.0+
Python
81
star
10

postmortem-docs

PagerDuty's Public Postmortem Documentation
Dockerfile
66
star
11

chrome-notifier

Google Chrome extension for PagerDuty desktop notifications.
JavaScript
60
star
12

pdjs

JavaScript wrapper for the PagerDuty API
TypeScript
59
star
13

API_Python_Examples

Examples of using the REST API endpoints in Python
Python
50
star
14

pdagent

The PagerDuty Agent is a program that lets you easily integrate your monitoring system with PagerDuty.
Python
33
star
15

api-schema

PagerDuty OpenAPI schemas
30
star
16

lita-pagerduty

A PagerDuty plugin for Lita
Ruby
25
star
17

backstage-plugin

PagerDuty plugin for Backstage
TypeScript
25
star
18

full-service-ownership-docs

PagerDuty's Full Service Ownership Documentation
Dockerfile
22
star
19

cronner

cron job runner; statsd metrics with optional DogStatsd event emissions
Go
20
star
20

operational-review-docs

PagerDuty's public operational review documentation.
Dockerfile
20
star
21

pagerduty-zabbix-py

Zabbix Integration for PagerDuty via Python Wrapper
Python
15
star
22

dnsmetrics

DNSmetrics connects to your accounts at multiple managed DNS providers using their APIs and emits standardized metrics in statsd format for easy ingestion into your monitoring solution of choice.
Go
14
star
23

devsecops-docs

DevSecOps Guide, located devsecops.pagerduty.com
Dockerfile
13
star
24

chef_example

This is a snapshot of the way we organized our Chef repo at the end of 2013, referenced by a PagerDuty Blog post.
Ruby
12
star
25

pdagent-integrations

Shell
12
star
26

go-pdagent

A new PagerDuty agent.
Go
11
star
27

pagerduty-nagios-pl

Nagios Integration for PagerDuty via Perl Wrapper
Perl
11
star
28

developer-docs

PagerDuty's developer documentation
11
star
29

PD-IP-Checker

Shell
9
star
30

pd-sync-chef

A knife plugin that supports the PagerDuty Chef workflow
Ruby
9
star
31

retrospectives-docs

PagerDuty's Retrospectives Documentation.
Dockerfile
9
star
32

blender-chef

Chef search based host discovery for blender.
Ruby
9
star
33

pagerduty-change-events-action

A GitHub action that creates a PagerDuty change event.
JavaScript
9
star
34

chef-sumologic

Recipe for an unattended install of Sumo Logic's sumocollector via chef
Ruby
9
star
35

stakeholder-comms-docs

PagerDuty's Stakeholder Communications Documentation.
Dockerfile
9
star
36

business-response-docs

PagerDuty's Business Incident Response Documentation -
Dockerfile
8
star
37

automated-remediation-docs

PagerDuty's Automated Remediation Ops Guide Docs
Dockerfile
7
star
38

mixduty

An elixir client for PagerDuty's API v2
Elixir
7
star
39

goingoncall-docs

Repository for the Best Practices for On Call Teams Ops Guide
Dockerfile
7
star
40

SwiftCompactCalendar

A compact calendar view for managing dates of a Calendar in Swift.
Swift
6
star
41

API_Ruby_Examples

Examples of using the REST API endpoints in Ruby
Ruby
6
star
42

API_PHP_Examples

Examples of using the PagerDuty API endpoints in PHP
PHP
5
star
43

full-case-ownership-docs

PagerDuty's Ops Guide for Customer Service Operations and Full Case Ownership
Dockerfile
5
star
44

ZenPacks.PagerDuty.APINotification

PagerDuty's Zenoss Zenpack
Python
4
star
45

chef-search-stresser

A utility in Go to stress a chef-server with wide searches
Go
4
star
46

mkdocs-theme-pagerduty

A custom MkDocs theme for all our public Ops Guide websites.
CSS
3
star
47

backstage-plugin-backend

PagerDuty plugin for Backstage - Backend
TypeScript
3
star
48

twitter-trend-alert-system

Python
3
star
49

app-documentation-templates

This is a public repository of documentation templates which PagerDuty app and integration builders can use to document what they build.
3
star
50

backstage-plugin-scaffolder-actions

Backstage scaffolder actions for PagerDuty
TypeScript
2
star
51

pd-bizops-aether

salesforce to redshift replication
Ruby
2
star
52

backstage-plugin-common

This project exposes common types and objects to PagerDuty's frontend and backend plugins for Backstage
TypeScript
2
star
53

postincident-howie-docs

Dockerfile
2
star
54

state-history-validator

Ruby
2
star
55

pagerduty-icinga-pl

Icinga Integration for PagerDuty via Perl Wrapper
Perl
2
star
56

interview-skeleton

Public sample code for a variety of languages for the API interview coding exercise
Elixir
1
star
57

scom-powershell-integration

PowerShell
1
star
58

plug_datadog_stats

Elixir
1
star
59

interview-java-skeleton

Java
1
star
60

security-hub-cloudformation

Contains PagerDuty's CloudFormation Template for Security Hub Integration
1
star
61

pd-feature-cookbook

This is a library cookbook that adds support for rule-based feature flags to Chef recipes.
Ruby
1
star
62

whazzup

A health check daemon for datastore services (MySQL, Zookeeper) that exposes health as an HTTP endpoint.
Ruby
1
star
63

cookbooks-vagrant-ohai

Ohai plugin for improvements to Vagrant network addresses. Forked from bryanwb/cookbooks-vagrant-ohai
Ruby
1
star
64

backstage-plugin-docs

Documentation for PagerDuty plugin for Backstage
HTML
1
star
65

servicenow-updatesets

This repo contains update sets to be used with creating Clone Data Preservers in ServiceNow. These are compatible with versions 5 and 6 of the PagerDuty app.
1
star