-
-
Notifications
You must be signed in to change notification settings - Fork 737
Add more configuration examples #167
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
While I am satisfied with the verbosity of the documentation in the
README.mdfile, I'd like to add more examples to theexamplesfolder.Unlike the current examples, would be configuration only (i.e. a folder with nothing except a
config.yamlinside of it).Furthermore, renaming
examplesto.examplesas well as updating every current references to said folder in theREADME.md.Here's a list of some examples I'd like to see:
So to recap:
examples/folder to.examples/examples/folder to use.examples/.examples/minimalto.examples/docker-minimal.examples/dns/config.yamlcontaining an endpoint monitored through DNS queries.examples/tcp/config.yamlcontaining an endpoint monitored through TCP.examples/alerting/config.yamlcontaining an endpoint with one of the providers configured (note: the webhook/tokens must be at least partially hidden)