From: Ben Kochie <bjk@gitlab.com>
Date: Thu, 20 Jul 2017 09:13:42 +0000 (+0200)
Subject: Add large link to config docs
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=5a703c76bc4ae222a9f03160d0f2b0c8ca9d446b;p=blackbox_exporter.git

Add large link to config docs

Make the Configuration section header link to the configuration doc.
* Use relative link[0].

[0]: https://help.github.com/articles/about-readmes/#relative-links-and-image-paths-in-readme-files
---

diff --git a/README.md b/README.md
index 1accdfc..31f8485 100644
--- a/README.md
+++ b/README.md
@@ -22,19 +22,18 @@ will return metrics for a HTTP probe against google.com. The `probe_success` met
     docker build -t blackbox_exporter .
     docker run -d -p 9115:9115 --name blackbox_exporter -v `pwd`:/config blackbox_exporter -config.file=/config/blackbox.yml
 
-## Configuration
+## [Configuration](CONFIGURATION.md)
 
-Blackbox exporter is configured via a configuration file and command-line flags (such as what configuration file to load, what port to listen on, and the logging format and level).
+Blackbox exporter is configured via a [configuration file](CONFIGURATION.md) and command-line flags (such as what configuration file to load, what port to listen on, and the logging format and level).
 
 Blackbox exporter can reload its configuration file at runtime. If the new configuration is not well-formed, the changes will not be applied.
 A configuration reload is triggered by sending a `SIGHUP` to the Blackbox exporter process or by sending a HTTP POST request to the `/-/reload` endpoint.
 
 To view all available command-line flags, run `./blackbox_exporter -h`.
 
-To specify which configuration file to load, use the `-config.file` flag.
-The file is written in [YAML format](https://en.wikipedia.org/wiki/YAML), defined by the scheme described which can be found [here.](https://github.com/prometheus/blackbox_exporter/blob/master/CONFIGURATION.md)
+To specify which [configuration file](CONFIGURATION.md) to load, use the `-config.file` flag.
 
-Additionally, an [example configuration](https://github.com/prometheus/blackbox_exporter/blob/master/example.yml) is also available.
+Additionally, an [example configuration](example.yml) is also available.
 
 HTTP, HTTPS (via the `http` prober), DNS, TCP socket and ICMP (see permissions section) are currently supported.
 Additional modules can be defined to meet your needs.