aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2016-10-17 07:51:44 +0100
committerGravatar Miek Gieben <miek@miek.nl> 2016-10-17 07:51:44 +0100
commitbe3c0195b68ab47048959bd04d2fc8b60590c730 (patch)
tree9e0628f29533881f232300c6e727bd5185003bc7
parenta69e88db62eba5cbb96c6feac74c55abe78c36b9 (diff)
downloadcoredns-be3c0195b68ab47048959bd04d2fc8b60590c730.tar.gz
coredns-be3c0195b68ab47048959bd04d2fc8b60590c730.tar.zst
coredns-be3c0195b68ab47048959bd04d2fc8b60590c730.zip
middleware.md: put in the same doc
Move middleware/middleware.md to middleware.md. This should be the canonical place where to document how middlewares should look and act.
-rw-r--r--middleware.md30
-rw-r--r--middleware/middleware.md24
2 files changed, 29 insertions, 25 deletions
diff --git a/middleware.md b/middleware.md
index 711d9c4ad..cef243198 100644
--- a/middleware.md
+++ b/middleware.md
@@ -1,4 +1,6 @@
-# Writing middleware
+# Middleware
+
+## Writing Middleware
From the Caddy docs:
@@ -26,3 +28,29 @@ So CoreDNS treats:
as special and will then assume nothing has written to the client. In all other cases it is assumes
something has been written to the client (by the middleware).
+
+## Hooking it up
+
+TODO(miek): text here on how to hook up 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:
+
+* Title: use the middleware's name
+* Subsection titled: "Syntax"
+* Subsection titled: "Examples"
+
+More sections are of course possible.
+
+## Style
+
+We use the Unix manual page style:
+
+* The name of middleware in the running text should be italic: *middleware*.
+* all CAPITAL: user supplied argument, in the running text references this use strong text: `**`:
+ **EXAMPLE**.
+* Optional text: in block quotes: `[optional]`.
+* Use three dots to indicate multiple options are allowed: `arg...`.
+* Item used literal: `literal`.
diff --git a/middleware/middleware.md b/middleware/middleware.md
deleted file mode 100644
index 928829397..000000000
--- a/middleware/middleware.md
+++ /dev/null
@@ -1,24 +0,0 @@
-# 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:
-
-* Title: use the middleware's name
-* Subsection titled: "Syntax"
-* Subsection titled: "Examples"
-
-More sections are of course possible.
-
-## Style
-
-We use the Unix manual page style:
-
-* The name of middleware in the running text should be italic: *middleware*.
-* all CAPITAL: user supplied argument, in the running text references this use strong text: `**`:
- **EXAMPLE**.
-* Optional text: in block quotes: `[optional]`.
-* Use three dots to indicate multiple options are allowed: `arg...`.
-* Item used literal: `literal`.