prometheus-operator / runbooks

https://runbooks.prometheus-operator.dev
Apache License 2.0
93 stars 172 forks source link

Page headers with or without spaces #25

Open nvtkaszpir opened 2 years ago

nvtkaszpir commented 2 years ago

Issue: Overall alerts are CamelCase which helps to find them, but makes hard to read them. Right now in PRs files have speecial header, which instructs Hugo to change page title. And then in the next lines there is first header in CamelCase.

This helps to have a nice page title on the left and horrible title on the page but also helps to find alerts with direct name.

Removing entries without spaces makes them impossible to find via such short alert name, which is a bit problematic.

The best option is to be able to have nice titles and finding pages with CamelCase alert name, so maybe adding some special keyword? Will have to look into the Hugo options or something.

Suggestions?