aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--plugin/autopath/README.md12
-rw-r--r--plugin/chaos/README.md2
-rw-r--r--plugin/erratic/README.md6
-rw-r--r--plugin/federation/README.md2
-rw-r--r--plugin/health/README.md2
-rw-r--r--plugin/kubernetes/README.md5
-rw-r--r--plugin/metrics/README.md2
-rw-r--r--plugin/pprof/README.md2
-rw-r--r--plugin/reverse/README.md6
-rw-r--r--plugin/trace/README.md3
10 files changed, 21 insertions, 21 deletions
diff --git a/plugin/autopath/README.md b/plugin/autopath/README.md
index 02b4390fc..4d3125dbf 100644
--- a/plugin/autopath/README.md
+++ b/plugin/autopath/README.md
@@ -1,12 +1,12 @@
# autopath
-The *autopath* plugin allows CoreDNS to perform server side search path completion.
-If it sees a query that matches the first element of the configured search path, *autopath* will
-follow the chain of search path elements and returns the first reply that is not NXDOMAIN.
-On any failures the original reply is returned.
+*autopath* allows CoreDNS to perform server side search path completion.
-Because *autopath* returns a reply for a name that wasn't the original question it will add a CNAME
-that points from the original name (with the search path element in it) to the name of this answer.
+If it sees a query that matches the first element of the configured search path, *autopath* will
+follow the chain of search path elements and returns the first reply that is not NXDOMAIN. On any
+failures the original reply is returned. Because *autopath* returns a reply for a name that wasn't
+the original question it will add a CNAME that points from the original name (with the search path
+element in it) to the name of this answer.
## Syntax
diff --git a/plugin/chaos/README.md b/plugin/chaos/README.md
index 4c43590e5..3dfcc1112 100644
--- a/plugin/chaos/README.md
+++ b/plugin/chaos/README.md
@@ -1,6 +1,6 @@
# chaos
-The *chaos* plugin allows CoreDNS to respond to TXT queries in the CH class.
+*chaos* allows CoreDNS to respond to TXT queries in the CH class.
This is useful for retrieving version or author information from the server.
diff --git a/plugin/erratic/README.md b/plugin/erratic/README.md
index 81074fa97..f606eef42 100644
--- a/plugin/erratic/README.md
+++ b/plugin/erratic/README.md
@@ -1,14 +1,14 @@
# erratic
-*erratic* is a plugin useful for testing client behavior. It returns a static response to all
-queries, but the responses can be delayed, dropped or truncated.
+*erratic* is a plugin useful for testing client behavior.
+It returns a static response to all queries, but the responses can be delayed, dropped or truncated.
The *erratic* plugin will respond to every A or AAAA query. For any other type it will return
a SERVFAIL response. The reply for A will return 192.0.2.53 (see RFC 5737), for AAAA it returns
2001:DB8::53 (see RFC 3849).
*erratic* can also be used in conjunction with the *autopath* plugin. This is mostly to aid in
- testing.
+testing.
## Syntax
diff --git a/plugin/federation/README.md b/plugin/federation/README.md
index 63369e47a..54aa3f824 100644
--- a/plugin/federation/README.md
+++ b/plugin/federation/README.md
@@ -1,6 +1,6 @@
# federation
-The *federation* plugin enables
+*federation* enables
[federated](https://kubernetes.io/docs/tasks/federation/federation-service-discovery/) queries to be
resolved via the kubernetes plugin.
diff --git a/plugin/health/README.md b/plugin/health/README.md
index 59aed3b81..195f21ab7 100644
--- a/plugin/health/README.md
+++ b/plugin/health/README.md
@@ -1,6 +1,6 @@
# health
-This module enables a simple health check endpoint. By default it will listen on port 8080.
+*health* enabless a simple health check endpoint. By default it will listen on port 8080.
## Syntax
diff --git a/plugin/kubernetes/README.md b/plugin/kubernetes/README.md
index 387f1cf75..cc8f09c49 100644
--- a/plugin/kubernetes/README.md
+++ b/plugin/kubernetes/README.md
@@ -1,7 +1,8 @@
# kubernetes
-The *kubernetes* plugin enables the reading zone data from a Kubernetes cluster. It implements
-the [Kubernetes DNS-Based Service Discovery
+The *kubernetes* plugin enables the reading zone data from a Kubernetes cluster.
+
+It implements the [Kubernetes DNS-Based Service Discovery
Specification](https://github.com/kubernetes/dns/blob/master/docs/specification.md).
CoreDNS running the kubernetes plugin can be used as a replacement of kube-dns in a kubernetes
diff --git a/plugin/metrics/README.md b/plugin/metrics/README.md
index d3189586d..8e84c57bf 100644
--- a/plugin/metrics/README.md
+++ b/plugin/metrics/README.md
@@ -1,6 +1,6 @@
# prometheus
-This module enables prometheus metrics for CoreDNS.
+*prometheus* enables [Prometheus](https://prometheus.io/) metrics for CoreDNS.
The default location for the metrics is `localhost:9153`. The metrics path is fixed to `/metrics`.
The following metrics are exported:
diff --git a/plugin/pprof/README.md b/plugin/pprof/README.md
index 6dbac694c..c1da992ca 100644
--- a/plugin/pprof/README.md
+++ b/plugin/pprof/README.md
@@ -1,6 +1,6 @@
# pprof
-*pprof* publishes runtime profiling data at endpoints under /debug/pprof.
+*pprof* publishes runtime profiling data at endpoints under `/debug/pprof`.
You can visit `/debug/pprof` on your site for an index of the available endpoints. By default it
will listen on localhost:6053.
diff --git a/plugin/reverse/README.md b/plugin/reverse/README.md
index 63a3a968c..0e0e4c7a6 100644
--- a/plugin/reverse/README.md
+++ b/plugin/reverse/README.md
@@ -1,6 +1,6 @@
# reverse
-The *reverse* plugin allows CoreDNS to respond dynamically to a PTR request and the related A/AAAA request.
+*reverse* allows CoreDNS to respond dynamically to a PTR request and the related A/AAAA request.
## Syntax
@@ -38,7 +38,7 @@ The zone will be matched by the zones listed in *this* configuration stanza.
## Examples
-~~~ txt
+~~~ corefile
arpa compute.internal {
# proxy unmatched requests
proxy . 8.8.8.8
@@ -63,7 +63,7 @@ arpa compute.internal {
~~~
-~~~ txt
+~~~ corefile
32.10.in-addr.arpa.arpa arpa.company.org {
reverse 10.32.0.0/16 {
diff --git a/plugin/trace/README.md b/plugin/trace/README.md
index 044b6fdcc..4383423e5 100644
--- a/plugin/trace/README.md
+++ b/plugin/trace/README.md
@@ -1,7 +1,6 @@
# trace
-This module enables OpenTracing-based tracing of DNS requests as they go through the
-plugin chain.
+*trace* enables OpenTracing-based tracing of DNS requests as they go through the plugin chain.
## Syntax