Manual pages (#1346)

* Add manual pages

Generate manual pages from the README and extend README with Name and
Description sections.

The generation requires 'ronn' which may not be available. Just check in
all generated manual pages.
This commit is contained in:
Miek Gieben
2018-01-04 12:53:07 +00:00
committed by GitHub
parent 0600f8c058
commit 58221f55db
62 changed files with 3397 additions and 97 deletions

View File

@@ -1,8 +1,13 @@
# health
*health* enables a simple health check endpoint.
## Name
By default, it listens on port 8080.
*health* - enables a health check endpoint.
## Description
By enabling *health* any plugin that implements it will be queried for it's health. The combined
health is exported, by default, on port 8080/health .
## Syntax