Add readme and add collapsible "full context" sections

prometheus-operator / runbooks

https://runbooks.prometheus-operator.dev

Apache License 2.0

88 stars 164 forks source link

Add readme and add collapsible "full context" sections #10

Closed mac-chaffee closed 2 years ago

mac-chaffee commented 2 years ago

This PR does the following:

Adds a readme, including guidelines mentioned in #9
Adds a collapsible section to many pages which contains a lot more details about some alerts. The section is collapsible since an experienced SRE would likely want to skip it, but a novice would click it if they need additional guidance.
Expanded KubeletTooManyPods

netlify[bot] commented 2 years ago

✔️ Deploy Preview for distracted-northcutt-e0bccc ready!

🔨 Explore the source changes: 669b276f3a7cd01e887c8b1fb5a7b3cbe978128b

🔍 Inspect the deploy log: https://app.netlify.com/sites/distracted-northcutt-e0bccc/deploys/61fbee46e461300007ccbcf2

😎 Browse the preview: https://deploy-preview-10--distracted-northcutt-e0bccc.netlify.app

mac-chaffee commented 2 years ago

Looks like the preview app is using absolute links. Not sure why since it's using relative links locally.

Also, locally I see that my <details> tags are being stripped out. So don't merge this yet, I'll have to find another way to do collapsible sections in Hugo's flavor of markdown. Or we may just have to put the section at the end. EDIT: Fixed this by enabling "unsafe" mode: https://gohugo.io/getting-started/configuration-markup#goldmark