PagerDuty/incident-response-docs

# PagerDuty 事件响应文档 [](https://app.netlify.com/sites/incident-response-docs/deploys) 这是 PagerDuty 内部使用的事件响应流程的公开版本。它也用于为新员工准备 on-call 职责，不仅提供了如何为事件做准备的信息，还包含了事件发生期间和之后应该做什么。请查看 [关于页面](docs/about.md) 以获取有关此文档的内容及其存在原因的更多信息。 你可以直接[在此仓库中](docs/index.md)查看文档，或访问 https://response.pagerduty.com 查看渲染后的网站。 [](https://response.pagerduty.com) ## 开发 我们使用 [MkDocs](https://www.mkdocs.org/) 从此仓库创建静态网站。 ### 本地 要在本地设备上进行开发， 1. 安装 [MkDocs](https://www.mkdocs.org/user-guide/installation/)。`pip install mkdocs` 2. 安装 [MkDocs PyMdown Extensions](https://squidfunk.github.io/mkdocs-material/extensions/pymdown/)。`pip install pymdown-extensions` 3. 如果你想为代码示例添加语法高亮，请安装 [Pygments](https://pygments.org/)。`pip install pygments` 4. 安装 [PagerDuty MkDocs 主题](https://github.com/pagerduty/mkdocs-theme-pagerduty)。 1. `git clone https://github.com/pagerduty/mkdocs-theme-pagerduty` 2. `cd mkdocs-theme-pagerduty & python3 setup.py install` 5. 要在本地进行测试，请在项目目录中运行 `mkdocs serve`。 6. 你现在可以在浏览器中通过 `http://127.0.0.1:8000` 查看网站。当你编辑代码时，网站会自动更新。 ### Docker 要使用 Docker 进行本地开发， 1. 构建 Docker 镜像并加载以便立即使用。`docker build --load -t mkdocs .` 2. 运行容器并映射你当前的工作目录。`docker run -v $(pwd):/docs -p 127.0.0.1:8000:8000 mkdocs` 3. 你现在可以在浏览器中通过 `http://127.0.0.1:8000` 查看网站。当你编辑代码时，网站会自动更新。 _注意：如果你使用的是 Apple Silicon 设备，请在 `docker build` 命令中添加 `--platform linux/arm64/v8` 以获取原生 Apple Silicon 镜像。这会比转译 arm64 镜像运行得更快。_ ## 部署 1. 运行 `mkdocs build --clean` 生成用于上传的静态网站。 2. 将 `site` 目录上传到 S3（或任何你想要托管的地方）。 aws s3 sync ./site/ s3://[BUCKET_NAME] \ --acl public-read \ --exclude "*.py*" \ --delete ## 许可证 [Apache 2](https://www.apache.org/licenses/LICENSE-2.0)（参见 [LICENSE](LICENSE) 文件） ## 贡献 感谢你考虑做出贡献！如果你有任何问题，直接提问就好——或者直接提交你的 issue 或 pull request。最坏的结果也只是我们会礼貌地请你修改一些内容。我们感激所有友好的贡献。 以下是我们提交 pull request 的首选流程， 1. Fork 该仓库（ https://github.com/PagerDuty/incident-response-docs/fork ） 2. 创建你的功能分支（`git checkout -b my-new-feature`） 3. 提交你的更改（`git commit -am 'Add some feature'`） 4. 推送到该分支（`git push origin my-new-feature`） 5. 创建一个新的 Pull Request。

标签：SRE, 偏差过滤, 库, 应急响应, 文档, 最佳实践, 请求拦截, 运维, 逆向工具