diff --git a/documentation/prometheus-mixin/.gitignore b/documentation/prometheus-mixin/.gitignore new file mode 100644 index 000000000..b23a75c9b --- /dev/null +++ b/documentation/prometheus-mixin/.gitignore @@ -0,0 +1,4 @@ +*.yaml +dashboards_out +vendor +jsonnetfile.lock.json diff --git a/documentation/prometheus-mixin/README.md b/documentation/prometheus-mixin/README.md index 9596f381f..01a7aadeb 100644 --- a/documentation/prometheus-mixin/README.md +++ b/documentation/prometheus-mixin/README.md @@ -1,6 +1,13 @@ # Prometheus Mixin -The Prometheus Mixin is a set of configurable, reusable and extensible alerts +The Prometheus Mixin is a set of configurable, reusable, and extensible alerts and dashboards for Prometheus. For instructions on how to use mixins, see https://github.com/monitoring-mixins/docs. + + +TODO: need jsonnet v0.10+ +TODO: add MAkefile, explain things. + +go get github.com/google/go-jsonnet/cmd/jsonnet +go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb