diff options
| author |  Miek Gieben <miek@miek.nl>
| 2016-10-18 07:47:18 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2016-10-18 07:47:18 +0100 |
| commit | 89a2912c87c7b1d38d8e2a11e8f88183a09b38fe (patch) | |
| tree | 1b3b6eb93f2e2722bfb30a9fda3d03e2fd9d53ef /middleware.md | |
| parent | a6b033a936d9f109c0c04b34abcd5cf0c60ecabc (diff) | |
| download | coredns-89a2912c87c7b1d38d8e2a11e8f88183a09b38fe.tar.gz coredns-89a2912c87c7b1d38d8e2a11e8f88183a09b38fe.tar.zst coredns-89a2912c87c7b1d38d8e2a11e8f88183a09b38fe.zip | |
Documentation updates (#340)
Diffstat (limited to 'middleware.md')
| -rw-r--r-- | middleware.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/middleware.md b/middleware.md index cef243198..acd69f497 100644 --- a/middleware.md +++ b/middleware.md @@ -33,7 +33,12 @@ something has been written to the client (by the middleware). TODO(miek): text here on how to hook up middleware. -# Documentation +## Metrics + +When exporting metrics the *Namespace* should be `middleware.Namespace` (="coredns"), and the +*Subsystem* should be the name of the middleware. + +## Documentation Each middleware should have a README.md explaining what the middleware does and how it is configured. The file should have the following layout: @@ -44,7 +49,7 @@ configured. The file should have the following layout: More sections are of course possible. -## Style +### Style We use the Unix manual page style: |