-
-
Notifications
You must be signed in to change notification settings - Fork 689
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
While I am satisfied with the verbosity of the documentation in the README.md file, I'd like to add more examples to the examples folder.
Unlike the current examples, would be configuration only (i.e. a folder with nothing except a config.yaml inside of it).
Furthermore, renaming examples to .examples as well as updating every current references to said folder in the README.md.
Here's a list of some examples I'd like to see:
- With an endpoint monitored through DNS queries
- With an endpoint monitored through TCP
- With some alerting providers (e.g. Slack, Discord)
- Anything else that you can think of.
So to recap:
- Rename
examples/folder to.examples/ - Update all old references to the
examples/folder to use.examples/ - Rename
.examples/minimalto.examples/docker-minimal - Create an example configuration in
.examples/dns/config.yamlcontaining an endpoint monitored through DNS queries - Create an example configuration in
.examples/tcp/config.yamlcontaining an endpoint monitored through TCP - Create an example configuration in
.examples/alerting/config.yamlcontaining an endpoint with one of the providers configured (note: the webhook/tokens must be at least partially hidden)
Reactions are currently unavailable
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