From 166e7c437d0c8a654b2398a5441facbfd548a940 Mon Sep 17 00:00:00 2001 From: Mac Chaffee Date: Wed, 2 Feb 2022 22:05:46 -0500 Subject: [PATCH] Move guidelines section to add-runbook, add local testing info Signed-off-by: Mac Chaffee --- .gitignore | 1 + README.md | 13 +------------ content/docs/add-runbook.md | 14 ++++++++++++++ 3 files changed, 16 insertions(+), 12 deletions(-) diff --git a/.gitignore b/.gitignore index 73ab876..1c3fa73 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ public/ resources/ +.hugo_build.lock diff --git a/README.md b/README.md index 800a985..7ce30bb 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,4 @@ This repo contains the official [runbooks](https://en.wikipedia.org/wiki/Runbook The live version can be found at https://runbooks.prometheus-operator.dev/ -## Contributing - -To edit or expand an existing runbook, feel free to edit the files under `content/` and submit a pull request. - -To create a new runbook, see [add-runbook.md](./content/docs/add-runbook.md). - - -## Guidelines - -The purpose of this repository is to have a documentation about every alert shipped by kube-prometheus (not only by prometheus-operator). In the long run, we are aiming to support as many k8s flavors as possible. If possible try to ensure the 'Diagnosis/Mitigation' sections are applicable to all certified kubernetes distributions. - -The primary target for these runbooks are folks who are novices and don't have much insight into what to do with alerts shipped in kube-prometheus. As a result, try to avoid excessive jargon and abbreviations. +For information about contributing, see [add-runbook.md](./content/docs/add-runbook.md). diff --git a/content/docs/add-runbook.md b/content/docs/add-runbook.md index 6ca41ec..25f0207 100644 --- a/content/docs/add-runbook.md +++ b/content/docs/add-runbook.md @@ -72,3 +72,17 @@ Is this some irregular condition, e.g. a process fails to clean up behind itself [1]: https://github.github.com/gfm/#html-block ``` + +### Guidelines + +The purpose of this repository is to have a documentation about every alert shipped by kube-prometheus (not only by prometheus-operator). In the long run, we are aiming to support as many k8s flavors as possible. If possible try to ensure the 'Diagnosis/Mitigation' sections are applicable to all certified kubernetes distributions. + +The primary target for these runbooks are folks who are novices and don't have much insight into what to do with alerts shipped in kube-prometheus. As a result, try to avoid excessive jargon and abbreviations. + +### Testing locally + +To test your changes locally: + +1. Install [Hugo](https://gohugo.io/getting-started/installing/) +2. Run `git submodule init` and `git submodule update` to clone the Hugo theme +3. Run `hugo server` and navigate to http://localhost:1313/ in your browser