37 lines
2.3 KiB
Markdown
37 lines
2.3 KiB
Markdown
|
# Spearhead Systems Issue Response Documentation [](https://travis-ci.com/PagerDuty/incident-response-docs)
|
||
|
|
This is a public version of the Issue Response process used at Spearhead Ststems. It is based on the PagerDuty Incident Response process, modified to fit our specific requirements. It is used to prepare new employees for on-call responsibilities, and provides information not only on preparing for an issue (incident or service request), but also what to do during and after. See the [about page](docs/about.md) for more information on what this documentation is and why it exists.
|
||
|
|
|
||
|
|
You can view the documentation [directly](/docs/index.md) in this repository, or rendered as a website at https://response.spearhead.systems.
|
||
|
|
|
||
|
|
[](https://response.spearhead.systems)
|
||
|
|
|
||
|
|
## Development
|
||
|
|
We use [MkDocs](http://www.mkdocs.org/) to create a static site from this repository. For local development,
|
||
|
|
|
||
|
|
1. [Install MkDocs](http://www.mkdocs.org/#installation). `pip install mkdocs`
|
||
|
|
1. Install the [MkDocs Material theme](https://github.com/squidfunk/mkdocs-material). `pip install mkdocs-material`
|
||
|
|
1. To test locally, run `mkdocs serve` from the project directory.
|
||
|
|
|
||
|
|
## Deploying
|
||
|
|
1. Run `mkdocs build --clean` to produce the static site for upload.
|
||
|
|
1. 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](http://www.apache.org/licenses/LICENSE-2.0) (See [LICENSE](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 )
|
||
|
|
1. Create your feature branch (`git checkout -b my-new-feature`)
|
||
|
|
1. Commit your changes (`git commit -am 'Add some feature'`)
|
||
|
|
1. Push to the branch (`git push origin my-new-feature`)
|
||
|
|
1. Create a new Pull Request.
|