Describe the bug
The documentation in Icinga 2 API, Configuration Management, Create a Stage comes with a copy-and-pasteable example which is deliberately faulty.
The example below will create a new file called test.conf in the conf.d directory. Note: This example contains an error (chec_command). This is intentional.
While this is mentioned in the text, this is not highlighted and the first sentence implies this should work. Furthermore, there is no correct example.
I have stumbled across this now multiple times and was slightly annoyed every time.
To Reproduce
RTFM and try to create a config stage with blindly copy-and-pasting examples.
Expected behavior
Documentation should explain the working route next to faulty ones.
Describe the bug
The documentation in Icinga 2 API, Configuration Management, Create a Stage comes with a copy-and-pasteable example which is deliberately faulty.
While this is mentioned in the text, this is not highlighted and the first sentence implies this should work. Furthermore, there is no correct example.
I have stumbled across this now multiple times and was slightly annoyed every time.
To Reproduce
RTFM and try to create a config stage with blindly copy-and-pasting examples.
Expected behavior
Documentation should explain the working route next to faulty ones.