OBSDOCS-2647 Add a reference list for alerts to the monitoring documentation

[eromanova97]

Version(s): 4.20 +

Issue: https://issues.redhat.com/browse/OBSDOCS-2647

Link to docs preview: https://104437--ocpdocs-pr.netlify.app/openshift-monitoring/latest/alert-reference/alert-reference-for-the-cluster-monitoring-operator

QE review:

• QE has approved this change.

Additional information:

[ocpdocs-previewbot]

🤖 Wed Jan 07 08:34:33 - Prow CI generated the docs preview:

https://104437--ocpdocs-pr.netlify.app/openshift-monitoring/latest/alert-reference/alert-reference-for-the-cluster-monitoring-operator.html

[openshift-ci]

@eromanova97: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[eromanova97]

Note: instead of having it in the additional resources, I can also add the commands for how to extract alerting rules from the cluster.

[jan--f]

One thing that is a bit awkward is that we now end up with alert description templates references in the docs (see screenshot). There isn't really a way around this, as we don't have data to base this on. But perhaps we could

improve the formatting?

[eromanova97]

Hello @jan--f yes, I agree, I am also not sure if there is a way to fix this if we want to have this generated automatically. By improving formatting, do you have any particular suggestions? Like putting all the descriptions in monospace maybe? Although that might now work as well, because some of the descriptions already contain monospace, so it could possibly break the formatting 🤔

I will try to think more about this as well and see if I can come up with some other ideas 😄