github/runbooks
1
0
Fork 0
mirror of https://github.com/prometheus-operator/runbooks.git synced 2026-02-14 16:59:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add guidelines to readme based on #9. Closes #9

Browse Source 
Signed-off-by: Mac Chaffee <me@macchaffee.com>
This commit is contained in:
Mac Chaffee
2022-02-02 21:46:33 -05:00
parent 699dcbabba
commit fd91cb155c
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -8,4 +8,11 @@ The live version can be found at https://runbooks.prometheus-operator.dev/
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)
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.