From d9958abc03bfe1046f90159c0f14133bb443737d Mon Sep 17 00:00:00 2001 From: Miek Gieben Date: Mon, 26 Feb 2018 14:51:40 +0000 Subject: [PATCH] doc updates (#1563) Capatilize coredns in ADAPTERS.md --- ADOPTERS.md | 2 +- plugin.md | 9 +++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/ADOPTERS.md b/ADOPTERS.md index 9711d31da..e438fab7e 100644 --- a/ADOPTERS.md +++ b/ADOPTERS.md @@ -3,6 +3,6 @@ * [Kismia](https://kismia.com) uses CoreDNS for Kubernetes cluster DNS. * [Admiral](https://getadmiral.com) uses CoreDNS to handle geographic DNS requests for our public-facing microservices. * [Qunar](https://qunar.com) uses CoreDNS for service discovery of its GPU machine learning cloud with TensorFlow and Kubernetes. -* [seansean2](https://web.mit.edu) uses coreDNS in production at MIT for DNS. +* [seansean2](https://web.mit.edu) uses CoreDNS in production at MIT for DNS. * [Tradeshift](https://tradeshift.com/) uses CoreDNS to look up company identifiers across multiple shards/regions/zones * [SoundCloud](https://soundcloud.com/) uses CoreDNS as internal cache+proxy in Kubernetes clusters to handle hundreds of thousands DNS service discovery requests per second. diff --git a/plugin.md b/plugin.md index f5f950884..3e0bb86e9 100644 --- a/plugin.md +++ b/plugin.md @@ -8,9 +8,9 @@ The main method that gets called is `ServeDNS`. It has three parameters: * `dns.ResponseWriter` that is, basically, the client's connection; * `*dns.Msg` the request from the client. -`ServeDNS` returns two values, a response code and an error. If the error is not nil CoreDNS -will return a generic SERVFAIL to the client. The response code tells CoreDNS if a reply has been -written by the plugin chain or not. In the latter case CoreDNS will take care of that. +`ServeDNS` returns two values, a response code and an error. If the error is not nil CoreDNS, +will return a SERVFAIL to the client. The response code tells CoreDNS if a *reply has been +written by the plugin chain or not*. In the latter case CoreDNS will take care of that. CoreDNS treats: @@ -23,7 +23,8 @@ as special and will then assume *nothing* has been written to the client. In all assumes something has been written to the client (by the plugin). The [*example*](https://github.com/coredns/example) plugin shows a bare-bones implementation that -can be used as a starting point for your plugin. +can be used as a starting point for your plugin. This plugin has tests and extensive comments in the +code. ## Hooking It Up