diff --git a/docs/_functions/domain/IMPORT_TRANSFORM.md b/docs/_functions/domain/IMPORT_TRANSFORM.md index dbd573397..a5c121ef1 100644 --- a/docs/_functions/domain/IMPORT_TRANSFORM.md +++ b/docs/_functions/domain/IMPORT_TRANSFORM.md @@ -55,14 +55,14 @@ var TRANSFORM_INT = [ { low: "2.4.6.80", high: "2.4.6.90", newBase: "123.123.123.200" }, // Another rule, just to show that you can have many. ] -D("foo.com", .... , +D("foo.com", .... , A("one","1.2.3.1") A("two","1.2.3.2") A("three","1.2.3.13") A("four","1.2.3.14") ); -D("bar.com", .... , +D("bar.com", .... , A("www","123.123.123.123") IMPORT_TRANSFORM(TRANSFORM_INT, 'foo.com', 300), ); diff --git a/docs/_functions/domain/PTR.md b/docs/_functions/domain/PTR.md index eabac1f81..8c0fc7a4b 100644 --- a/docs/_functions/domain/PTR.md +++ b/docs/_functions/domain/PTR.md @@ -31,11 +31,11 @@ is inappropriate for the domain. For example `PTR('1.2.3.4', 'f.co.')` is valid for the domain `D("3.2.1.in-addr.arpa',` but DNSControl will generate an error if the domain is `D("9.9.9.in-addr.arpa',`. This is because `1.2.3.4` is contained in `1.2.3.0/24` but not `9.9.9.0/24`. -This validation works for IPv6, IPv4, and +This validation works for IPv6, IPv4, and RFC2317 "Classless in-addr.arpa delegation" domains. *Automatic truncation:* DNSControl will automatically truncate FQDNs -as needed. +as needed. If the name is a FQDN ending with `.`, DNSControl will verify that the name is contained within the CIDR block implied by domain. For example if name is `4.3.2.1.in-addr.arpa.` (note the trailing `.`) diff --git a/docs/_functions/global/NewRegistrar.md b/docs/_functions/global/NewRegistrar.md index a3a3afc7f..65b45c2a9 100644 --- a/docs/_functions/global/NewRegistrar.md +++ b/docs/_functions/global/NewRegistrar.md @@ -7,7 +7,7 @@ parameters: return: string --- -NewRegistrar registers a registrar provider. The name can be any string value you would like to use. +NewRegistrar registers a registrar provider. The name can be any string value you would like to use. The type must match a valid registar provider type identifer (see [provider page.]({{site.github.url}}/provider-list)) Metadata is an optional object, that will only be used by certain providers. See [individual provider docs]({{site.github.url}}/provider-list) for specific details. @@ -21,4 +21,4 @@ var r53 = NewDnsProvider("R53","ROUTE53"); D("example.com", REGISTRAR, DnsProvider(r53), A("@","1.2.3.4")); {%endhighlight%} -{% include endExample.html %} \ No newline at end of file +{% include endExample.html %} diff --git a/docs/_functions/global/REV.md b/docs/_functions/global/REV.md index 49ee0321d..5e0040140 100644 --- a/docs/_functions/global/REV.md +++ b/docs/_functions/global/REV.md @@ -50,6 +50,6 @@ D(REV('2001:db8:302::/48'), REGISTRAR, DnsProvider(BIND), {%endhighlight%} {% include endExample.html %} -In the future we plan on adding a flag to `A()` which will insert +In the future we plan on adding a flag to `A()` which will insert the correct PTR() record if the approprate `D(REV()` domain (i.e. `.arpa` domain) has been defined. diff --git a/docs/_includes/startExample.html b/docs/_includes/startExample.html index 91fb44f0c..e47908e17 100644 --- a/docs/_includes/startExample.html +++ b/docs/_includes/startExample.html @@ -1,4 +1,4 @@ - Example{% if include.name %} ({{ include.name }}){%endif%}: + Example{% if include.name %} ({{ include.name }}){%endif%}: -
\ No newline at end of file +
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 6d8e2f68b..988d6e616 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -49,7 +49,7 @@ {% endunless %} {% comment %} This script makes the examples collapse appropriately {% endcomment %} - + - \ No newline at end of file + diff --git a/docs/_providers/activedir.md b/docs/_providers/activedir.md index 132fabafe..e1ef5b7c9 100644 --- a/docs/_providers/activedir.md +++ b/docs/_providers/activedir.md @@ -22,7 +22,7 @@ such information and saves a copy in a file called `adzonedump.ZONE.json` (where "ZONE" is replaced with the zone name). When `-fakeps` is enabled, the PowerShell command is not run, but the `adzonedump.ZONE.json` file is read. You can generate this file on a Windows system. -* Zone Changes: Normally when DNSControl needs to change DNS records, it +* Zone Changes: Normally when DNSControl needs to change DNS records, it executes PowerShell commands as required. When `-fakeps` is enabled, these commands are simply logged to a file `dns_update_commands.ps1`. diff --git a/docs/_providers/bind.md b/docs/_providers/bind.md index 8f51f608e..8a2d29ac7 100644 --- a/docs/_providers/bind.md +++ b/docs/_providers/bind.md @@ -5,7 +5,7 @@ jsId: BIND --- # Bind Provider -This provider simply maintains a directory with a collection of .zone files. We currently copy zone files to our production servers and restart bind via +This provider simply maintains a directory with a collection of .zone files. We currently copy zone files to our production servers and restart bind via a script external to DNSControl. ## Configuration diff --git a/docs/_providers/cloudflare.md b/docs/_providers/cloudflare.md index e2770ae78..b3917a344 100644 --- a/docs/_providers/cloudflare.md +++ b/docs/_providers/cloudflare.md @@ -128,6 +128,6 @@ D("chiphacker.com", REG_NAMECOM, DnsProvider(CFLARE), Notice a few details: -1. We need an A record with cloudflare proxy on, or the page rule will never run. +1. We need an A record with cloudflare proxy on, or the page rule will never run. 2. The IP address in those A records may be mostly irrelevant, as cloudflare should handle all requests (assuming some page rule matches). 3. Ordering matters for priority. CF_REDIRECT records will be added in the order they appear in your js. So put catch-alls at the bottom. diff --git a/docs/alias.md b/docs/alias.md index a26b935ae..0a9972a45 100644 --- a/docs/alias.md +++ b/docs/alias.md @@ -10,7 +10,7 @@ DNSControl adds an ALIAS record type, and leaves it up to the provider implement A few notes: -1. A provider must "opt-in" to supporting ALIAS records. When registering a provider, you specify which capabilities you support. Here is an example of how the +1. A provider must "opt-in" to supporting ALIAS records. When registering a provider, you specify which capabilities you support. Here is an example of how the cloudflare provider declares its support for aliases: ``` @@ -20,6 +20,6 @@ func init() { ``` 2. If you try to use ALIAS records, **all** dns providers for the domain must support ALIAS records. We do not want to serve inconsistent records across providers. -3. CNAMEs at `@` are disallowed, but ALIAS is allowed. +3. CNAMEs at `@` are disallowed, but ALIAS is allowed. 4. Cloudflare does not have a native ALIAS type, but CNAMEs behave similarly. The Cloudflare provider "rewrites" ALIAS records to CNAME as it sees them. Other providers may not need this step. diff --git a/docs/getting-started.md b/docs/getting-started.md index bc419fbdc..ccc57e4bc 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -58,7 +58,7 @@ D('example.com', REG_NONE, DnsProvider(DNS_BIND), ); {%endhighlight%} -You may modify this file to match your particular providers and domains. See [the javascript docs]({{site.github.url}}/js) and [the provider docs]({{site.github.url}}/provider-list) for more details. +You may modify this file to match your particular providers and domains. See [the javascript docs]({{site.github.url}}/js) and [the provider docs]({{site.github.url}}/provider-list) for more details. If you are using other providers, you will likely need to make a `creds.json` file with api tokens and other account information. For example, to use both name.com and Cloudflare, you would have: {% highlight js %} diff --git a/docs/js.md b/docs/js.md index fc7d50618..bd32235a9 100644 --- a/docs/js.md +++ b/docs/js.md @@ -5,7 +5,7 @@ layout: default # Javascript DSL DNSControl uses javascript as its primary input language to provide power and flexibility to configure your domains. The ultimate purpose of the javascript is to construct a -[DNSConfig](https://godoc.org/github.com/StackExchange/dnscontrol/models#DNSConfig) object that will be passed to the go backend and operated on. +[DNSConfig](https://godoc.org/github.com/StackExchange/dnscontrol/models#DNSConfig) object that will be passed to the go backend and operated on. {% include funcList.md title="Top Level Functions" dir="global" %} @@ -23,6 +23,6 @@ DNSControl uses javascript as its primary input language to provide power and fl } } f(); - $(window).on('hashchange',f); + $(window).on('hashchange',f); }) diff --git a/docs/migrating.md b/docs/migrating.md index 8b2056040..1232af6a3 100644 --- a/docs/migrating.md +++ b/docs/migrating.md @@ -10,7 +10,7 @@ least one zone. You should have a working `dnsconfig.js` file and ## General advice -First, use the +First, use the [Getting Started]({{site.github.url}}/getting-started) doc so that you have a working `dnsconfig.js` with at least one domain. diff --git a/docs/nameservers.md b/docs/nameservers.md index 196ebf35f..8166bb484 100644 --- a/docs/nameservers.md +++ b/docs/nameservers.md @@ -22,7 +22,7 @@ DNSControl attempts to manage these records for you as much as possible, accordi There are several different ways to declare nameservers for a zone: -1. Explicit [`NAMESERVER`](/js#NAMESERVER) records in a domain: +1. Explicit [`NAMESERVER`](/js#NAMESERVER) records in a domain: `NAMESERVER("ns1.myhost.tld")` 2. Request all nameservers to use from a provider (usually via api): diff --git a/docs/release-engineering.md b/docs/release-engineering.md index c51cea88a..81c376b2b 100644 --- a/docs/release-engineering.md +++ b/docs/release-engineering.md @@ -12,7 +12,7 @@ Edit the "Version" variable in `main.go` and commit. ``` vi main.go -git commit -m'Release v1.5' main.go +git commit -m'Release v1.5' main.go git tag v0.1.5 git push origin tag v0.1.5 ``` @@ -33,7 +33,7 @@ Review the git log using this command: Create the binaries and attach them to the release: - go run build/build.go + go run build/build.go NOTE: This command creates binaries with the version number and git hash embedded. It also builds the releases for all supported platforms (i.e. creates a .exe for Windows even if you are running on Linux. Isn't Go amazing?) @@ -75,7 +75,7 @@ https://github.com/StackExchange/dnscontrol/releases/tag/v0.1.5 So many new providers and features! Plus, a new testing framework that makes it easier to add big features without fear of breaking old ones. * list -* of +* of * major * changes ```