Documentation updates (#340)

This commit is contained in:
Miek Gieben
2016-10-18 07:47:18 +01:00
committed by GitHub
parent a6b033a936
commit 89a2912c87
2 changed files with 41 additions and 22 deletions

View File

@@ -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: