From 998c32ec5c9604101c635e7a63269da4e724c4ec Mon Sep 17 00:00:00 2001 From: Jeffrey Cafferata Date: Thu, 15 Feb 2024 14:53:46 +0100 Subject: [PATCH] DOCS: Broken documentation URL's (#2839) --- commands/types/dnscontrol.d.ts | 76 +++++++++---------- documentation/adding-new-rtypes.md | 10 +-- documentation/code-tricks.md | 10 +-- documentation/functions/domain/LOC.md | 10 +-- .../functions/domain/LOC_BUILDER_DD.md | 14 ++-- .../functions/domain/LOC_BUILDER_DMM_STR.md | 14 ++-- .../functions/domain/LOC_BUILDER_DMS_STR.md | 14 ++-- .../functions/domain/LOC_BUILDER_STR.md | 18 ++--- .../functions/domain/M365_BUILDER.md | 2 +- documentation/functions/domain/NO_PURGE.md | 6 +- documentation/index.md | 2 +- documentation/providers.md | 2 +- documentation/styleguide-doc.md | 2 +- 13 files changed, 90 insertions(+), 90 deletions(-) diff --git a/commands/types/dnscontrol.d.ts b/commands/types/dnscontrol.d.ts index 5df946bfb..2da2d9594 100644 --- a/commands/types/dnscontrol.d.ts +++ b/commands/types/dnscontrol.d.ts @@ -1423,10 +1423,10 @@ declare function IP(ip: string): number; * One must supply the `LOC()` js helper all parameters. If that seems like too * much work, see also helper functions: * - * * [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - build a `LOC` by supplying only **d**ecimal **d**egrees. - * * [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E - * * [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E - * * [`LOC_BUILDER_STR({})`](../record/LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works + * * [`LOC_BUILDER_DD({})`](LOC_BUILDER_DD.md) - build a `LOC` by supplying only **d**ecimal **d**egrees. + * * [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E + * * [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E + * * [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works * * ## Format ## * @@ -1466,9 +1466,9 @@ declare function LOC(deg1: number, min1: number, sec1: number, deg2: number, min * - alt (float32, optional) * - ttl (optional) * - * A helper to build [`LOC`](../domain/LOC.md) records. Supply four parameters instead of 12. + * A helper to build [`LOC`](LOC.md) records. Supply four parameters instead of 12. * - * Internally assumes some defaults for [`LOC`](../domain/LOC.md) records. + * Internally assumes some defaults for [`LOC`](LOC.md) records. * * The cartesian coordinates are decimal degrees, like you typically find in e.g. Google Maps. * @@ -1506,11 +1506,11 @@ declare function LOC(deg1: number, min1: number, sec1: number, deg2: number, min * ``` * * Part of the series: - * * [`LOC()`](../domain/LOC.md) - build a `LOC` by supplying all 12 parameters - * * [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y - * * [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E - * * [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E - * * [`LOC_BUILDER_STR({})`](../record/LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works + * * [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters + * * [`LOC_BUILDER_DD({})`](LOC_BUILDER_DD.md) - accepts cartesian x, y + * * [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E + * * [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E + * * [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works * * @see https://docs.dnscontrol.org/language-reference/domain-modifiers/loc_builder_dd */ @@ -1524,9 +1524,9 @@ declare function LOC_BUILDER_DD(opts: { label?: string; x: number; y: number; al * - alt (float32, optional) * - ttl (optional) * - * A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12. + * A helper to build [`LOC`](LOC.md) records. Supply three parameters instead of 12. * - * Internally assumes some defaults for [`LOC`](../domain/LOC.md) records. + * Internally assumes some defaults for [`LOC`](LOC.md) records. * * Accepts a string with decimal minutes (DMM) coordinates in the form: 25.24°S 153.15°E * @@ -1548,11 +1548,11 @@ declare function LOC_BUILDER_DD(opts: { label?: string; x: number; y: number; al * ``` * * Part of the series: - * * [`LOC()`](../domain/LOC.md) - build a `LOC` by supplying all 12 parameters - * * [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y - * * [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E - * * [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E - * * [`LOC_BUILDER_STR({})`](../record/LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works + * * [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters + * * [`LOC_BUILDER_DD({})`](LOC_BUILDER_DD.md) - accepts cartesian x, y + * * [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E + * * [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E + * * [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works * * @see https://docs.dnscontrol.org/language-reference/domain-modifiers/loc_builder_dmm_str */ @@ -1566,9 +1566,9 @@ declare function LOC_BUILDER_DMM_STR(opts: { label?: string; str: string; alt?: * - alt (float32, optional) * - ttl (optional) * - * A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12. + * A helper to build [`LOC`](LOC.md) records. Supply three parameters instead of 12. * - * Internally assumes some defaults for [`LOC`](../domain/LOC.md) records. + * Internally assumes some defaults for [`LOC`](LOC.md) records. * * Accepts a string with degrees, minutes, and seconds (DMS) coordinates in the form: 41°24'12.2"N 2°10'26.5"E * @@ -1591,11 +1591,11 @@ declare function LOC_BUILDER_DMM_STR(opts: { label?: string; str: string; alt?: * ``` * * Part of the series: - * * [`LOC()`](../domain/LOC.md) - build a `LOC` by supplying all 12 parameters - * * [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y - * * [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E - * * [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E - * * [`LOC_BUILDER_STR({})`](../record/LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works + * * [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters + * * [`LOC_BUILDER_DD({})`](LOC_BUILDER_DD.md) - accepts cartesian x, y + * * [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E + * * [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E + * * [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works * * @see https://docs.dnscontrol.org/language-reference/domain-modifiers/loc_builder_dms_str */ @@ -1609,13 +1609,13 @@ declare function LOC_BUILDER_DMS_STR(opts: { label?: string; str: string; alt?: * - alt (float32, optional) * - ttl (optional) * - * A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12. + * A helper to build [`LOC`](LOC.md) records. Supply three parameters instead of 12. * - * Internally assumes some defaults for [`LOC`](../domain/LOC.md) records. + * Internally assumes some defaults for [`LOC`](LOC.md) records. * * Accepts a string and tries all `LOC_BUILDER_DM*_STR({})` methods: - * * [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E - * * [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E + * * [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E + * * [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E * * ```javascript * D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER), @@ -1639,11 +1639,11 @@ declare function LOC_BUILDER_DMS_STR(opts: { label?: string; str: string; alt?: * ``` * * Part of the series: - * * [`LOC()`](../domain/LOC.md) - build a `LOC` by supplying all 12 parameters - * * [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y - * * [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E - * * [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E - * * [`LOC_BUILDER_STR({})`](../record/LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works + * * [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters + * * [`LOC_BUILDER_DD({})`](LOC_BUILDER_DD.md) - accepts cartesian x, y + * * [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E + * * [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E + * * [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works * * @see https://docs.dnscontrol.org/language-reference/domain-modifiers/loc_builder_str */ @@ -1653,7 +1653,7 @@ declare function LOC_BUILDER_STR(opts: { label?: string; str: string; alt?: numb * DNSControl offers a `M365_BUILDER` which can be used to simply set up Microsoft 365 for a domain in an opinionated way. * * It defaults to a setup without support for legacy Skype for Business applications. - * It doesn't set up SPF or DMARC. See [`SPF_BUILDER`](/language-reference/record-modifiers/dmarc_builder) and [`DMARC_BUILDER`](/language-reference/record-modifiers/spf_builder). + * It doesn't set up SPF or DMARC. See [`SPF_BUILDER`](SPF_BUILDER.md) and [`DMARC_BUILDER`](DMARC_BUILDER.md). * * ## Example * @@ -2031,7 +2031,7 @@ declare function NAPTR(subdomain: string, order: number, preference: number, ter * By setting `NO_PURGE` on a domain, this tells DNSControl not to delete the * records found in the domain. * - * It is similar to [`IGNORE`](domain/IGNORE.md) but more general. + * It is similar to [`IGNORE`](IGNORE.md) but more general. * * The original reason for `NO_PURGE` was that a legacy system was adopting * DNSControl. Previously the domain was managed via Microsoft DNS Server's GUI. @@ -2067,8 +2067,8 @@ declare function NAPTR(subdomain: string, order: number, preference: number, ter * * ## See also * - * * [`PURGE`](domain/PURGE.md) is the default, thus this command is a no-op - * * [`IGNORE`](domain/IGNORE.md) is similar to `NO_PURGE` but is more selective + * * [`PURGE`](PURGE.md) is the default, thus this command is a no-op + * * [`IGNORE`](IGNORE.md) is similar to `NO_PURGE` but is more selective * * @see https://docs.dnscontrol.org/language-reference/domain-modifiers/no_purge */ diff --git a/documentation/adding-new-rtypes.md b/documentation/adding-new-rtypes.md index 02f486c09..c55730bb3 100644 --- a/documentation/adding-new-rtypes.md +++ b/documentation/adding-new-rtypes.md @@ -16,7 +16,7 @@ Our general philosophy is: - Anywhere we have a special case for a particular Rtype, we use a `switch` statement and have a `case` for every single record type, usually with a `default:` case that calls `panic()`. This way developers adding a new record type will quickly find where they need to add code (the panic will tell them where). Before we did this, missing implementation code would go unnoticed for months. - Keep things alphabetical. If you are adding your record type to a case statement, function library, or whatever, please list it alphabetically along with the others when possible. -Step 2 requires `stringer`. +Step 2 requires `stringer`. ```shell go install golang.org/x/tools/cmd/stringer@latest ``` @@ -73,7 +73,7 @@ popd ``` - Add this feature to the feature matrix in `dnscontrol/build/generate/featureMatrix.go`. Add it to the variable `matrix` maintaining alphabetical ordering, which should look like this: - + {% code title="dnscontrol/build/generate/featureMatrix.go" %} ```diff func matrixData() *FeatureMatrix { @@ -98,7 +98,7 @@ popd {% endcode %} then add it later in the file with a `setCapability()` statement, which should look like this: - + {% code title="dnscontrol/build/generate/featureMatrix.go" %} ```diff ... @@ -322,9 +322,9 @@ Add the new file `FOO.md` to the documentation table of contents [`documentation ... * Record Modifiers ... - * [DMARC_BUILDER](functions/record/DMARC_BUILDER.md) + * [DMARC_BUILDER](functions/domain/DMARC_BUILDER.md) + * [FOO_HELPER](functions/record/FOO_HELPER.md) - * [SPF_BUILDER](functions/record/SPF_BUILDER.md) + * [SPF_BUILDER](functions/domain/SPF_BUILDER.md) ... ``` {% endcode %} diff --git a/documentation/code-tricks.md b/documentation/code-tricks.md index ac383943f..aad1a7229 100644 --- a/documentation/code-tricks.md +++ b/documentation/code-tricks.md @@ -4,10 +4,10 @@ Problem: It is difficult to get CAA and other records exactly right. Solution: Use a "builder" to construct it for you. -* [CAA Builder](functions/record/CAA_BUILDER.md) -* [DMARC Builder](functions/record/DMARC_BUILDER.md) -* [M365_BUILDER](functions/record/M365_BUILDER.md) -* [SPF Optimizer](functions/record/SPF_BUILDER.md) +* [CAA Builder](functions/domain/CAA_BUILDER.md) +* [DMARC Builder](functions/domain/DMARC_BUILDER.md) +* [M365_BUILDER](functions/domain/M365_BUILDER.md) +* [SPF Optimizer](functions/domain/SPF_BUILDER.md) # Repeat records in many domains (macros) @@ -157,5 +157,5 @@ domain exists, who requested it, any associated ticket numbers, and so on. We also comment the individual parts of a record. Look at the [SPF -Optimizer](functions/record/SPF_BUILDER.md) example. Each part of +Optimizer](functions/domain/SPF_BUILDER.md) example. Each part of the SPF record has a comment. diff --git a/documentation/functions/domain/LOC.md b/documentation/functions/domain/LOC.md index 829eb127f..efaa4130a 100644 --- a/documentation/functions/domain/LOC.md +++ b/documentation/functions/domain/LOC.md @@ -86,14 +86,14 @@ the LOC record type will supply defaults where values were absent on DNS import. One must supply the `LOC()` js helper all parameters. If that seems like too much work, see also helper functions: - * [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - build a `LOC` by supplying only **d**ecimal **d**egrees. - * [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E - * [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E - * [`LOC_BUILDER_STR({})`](../record/LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works + * [`LOC_BUILDER_DD({})`](LOC_BUILDER_DD.md) - build a `LOC` by supplying only **d**ecimal **d**egrees. + * [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E + * [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E + * [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works ## Format ## -The coordinate format for `LOC()` is: +The coordinate format for `LOC()` is: `degrees,minutes,seconds,[NnSs],deg,min,sec,[EeWw],altitude,size,horizontal_precision,vertical_precision` diff --git a/documentation/functions/domain/LOC_BUILDER_DD.md b/documentation/functions/domain/LOC_BUILDER_DD.md index 619ba675e..2756a4f70 100644 --- a/documentation/functions/domain/LOC_BUILDER_DD.md +++ b/documentation/functions/domain/LOC_BUILDER_DD.md @@ -23,9 +23,9 @@ parameter_types: - alt (float32, optional) - ttl (optional) -A helper to build [`LOC`](../domain/LOC.md) records. Supply four parameters instead of 12. +A helper to build [`LOC`](LOC.md) records. Supply four parameters instead of 12. -Internally assumes some defaults for [`LOC`](../domain/LOC.md) records. +Internally assumes some defaults for [`LOC`](LOC.md) records. The cartesian coordinates are decimal degrees, like you typically find in e.g. Google Maps. @@ -68,8 +68,8 @@ D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER), Part of the series: - * [`LOC()`](../domain/LOC.md) - build a `LOC` by supplying all 12 parameters - * [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y - * [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E - * [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E - * [`LOC_BUILDER_STR({})`](../record/LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works + * [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters + * [`LOC_BUILDER_DD({})`](LOC_BUILDER_DD.md) - accepts cartesian x, y + * [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E + * [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E + * [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works diff --git a/documentation/functions/domain/LOC_BUILDER_DMM_STR.md b/documentation/functions/domain/LOC_BUILDER_DMM_STR.md index 99e71bcd6..adf503735 100644 --- a/documentation/functions/domain/LOC_BUILDER_DMM_STR.md +++ b/documentation/functions/domain/LOC_BUILDER_DMM_STR.md @@ -20,9 +20,9 @@ parameter_types: - alt (float32, optional) - ttl (optional) -A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12. +A helper to build [`LOC`](LOC.md) records. Supply three parameters instead of 12. -Internally assumes some defaults for [`LOC`](../domain/LOC.md) records. +Internally assumes some defaults for [`LOC`](LOC.md) records. Accepts a string with decimal minutes (DMM) coordinates in the form: 25.24°S 153.15°E @@ -48,8 +48,8 @@ D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER), Part of the series: - * [`LOC()`](../domain/LOC.md) - build a `LOC` by supplying all 12 parameters - * [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y - * [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E - * [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E - * [`LOC_BUILDER_STR({})`](../record/LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works + * [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters + * [`LOC_BUILDER_DD({})`](LOC_BUILDER_DD.md) - accepts cartesian x, y + * [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E + * [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E + * [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works diff --git a/documentation/functions/domain/LOC_BUILDER_DMS_STR.md b/documentation/functions/domain/LOC_BUILDER_DMS_STR.md index 8a772bc5f..894ddd71f 100644 --- a/documentation/functions/domain/LOC_BUILDER_DMS_STR.md +++ b/documentation/functions/domain/LOC_BUILDER_DMS_STR.md @@ -20,9 +20,9 @@ parameter_types: - alt (float32, optional) - ttl (optional) -A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12. +A helper to build [`LOC`](LOC.md) records. Supply three parameters instead of 12. -Internally assumes some defaults for [`LOC`](../domain/LOC.md) records. +Internally assumes some defaults for [`LOC`](LOC.md) records. Accepts a string with degrees, minutes, and seconds (DMS) coordinates in the form: 41°24'12.2"N 2°10'26.5"E @@ -49,8 +49,8 @@ D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER), Part of the series: - * [`LOC()`](../domain/LOC.md) - build a `LOC` by supplying all 12 parameters - * [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y - * [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E - * [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E - * [`LOC_BUILDER_STR({})`](../record/LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works + * [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters + * [`LOC_BUILDER_DD({})`](LOC_BUILDER_DD.md) - accepts cartesian x, y + * [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E + * [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E + * [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works diff --git a/documentation/functions/domain/LOC_BUILDER_STR.md b/documentation/functions/domain/LOC_BUILDER_STR.md index 368f2bc90..74cab9f7b 100644 --- a/documentation/functions/domain/LOC_BUILDER_STR.md +++ b/documentation/functions/domain/LOC_BUILDER_STR.md @@ -20,14 +20,14 @@ parameter_types: - alt (float32, optional) - ttl (optional) -A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12. +A helper to build [`LOC`](LOC.md) records. Supply three parameters instead of 12. -Internally assumes some defaults for [`LOC`](../domain/LOC.md) records. +Internally assumes some defaults for [`LOC`](LOC.md) records. Accepts a string and tries all `LOC_BUILDER_DM*_STR({})` methods: - * [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E - * [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E + * [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E + * [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E {% code title="dnsconfig.js" %} @@ -55,8 +55,8 @@ D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER), Part of the series: - * [`LOC()`](../domain/LOC.md) - build a `LOC` by supplying all 12 parameters - * [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y - * [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E - * [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E - * [`LOC_BUILDER_STR({})`](../record/LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works + * [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters + * [`LOC_BUILDER_DD({})`](LOC_BUILDER_DD.md) - accepts cartesian x, y + * [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E + * [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E + * [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works diff --git a/documentation/functions/domain/M365_BUILDER.md b/documentation/functions/domain/M365_BUILDER.md index dd58e48ab..6661a71ea 100644 --- a/documentation/functions/domain/M365_BUILDER.md +++ b/documentation/functions/domain/M365_BUILDER.md @@ -24,7 +24,7 @@ parameter_types: DNSControl offers a `M365_BUILDER` which can be used to simply set up Microsoft 365 for a domain in an opinionated way. It defaults to a setup without support for legacy Skype for Business applications. -It doesn't set up SPF or DMARC. See [`SPF_BUILDER`](/language-reference/record-modifiers/dmarc_builder) and [`DMARC_BUILDER`](/language-reference/record-modifiers/spf_builder). +It doesn't set up SPF or DMARC. See [`SPF_BUILDER`](SPF_BUILDER.md) and [`DMARC_BUILDER`](DMARC_BUILDER.md). ## Example diff --git a/documentation/functions/domain/NO_PURGE.md b/documentation/functions/domain/NO_PURGE.md index b4b2a1795..9d511b5a7 100644 --- a/documentation/functions/domain/NO_PURGE.md +++ b/documentation/functions/domain/NO_PURGE.md @@ -12,7 +12,7 @@ other system. By setting `NO_PURGE` on a domain, this tells DNSControl not to delete the records found in the domain. -It is similar to [`IGNORE`](domain/IGNORE.md) but more general. +It is similar to [`IGNORE`](IGNORE.md) but more general. The original reason for `NO_PURGE` was that a legacy system was adopting DNSControl. Previously the domain was managed via Microsoft DNS Server's GUI. @@ -50,5 +50,5 @@ With introduction of `diff2` algorithm (enabled by default in v4.0.0), ## See also -* [`PURGE`](domain/PURGE.md) is the default, thus this command is a no-op -* [`IGNORE`](domain/IGNORE.md) is similar to `NO_PURGE` but is more selective +* [`PURGE`](PURGE.md) is the default, thus this command is a no-op +* [`IGNORE`](IGNORE.md) is similar to `NO_PURGE` but is more selective diff --git a/documentation/index.md b/documentation/index.md index 58b4a8ad7..4f785a531 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -18,7 +18,7 @@ Take advantage of the advanced features. Use macros and variables for easier upd * Supports 35+ [DNS Providers](providers.md) including [BIND](providers/bind.md), [AWS Route 53](providers/route53.md), [Google DNS](providers/gcloud.md), and [name.com](providers/namedotcom.md). * [Apply CI/CD principles](ci-cd-gitlab.md) to DNS: Unit-tests, system-tests, automated deployment. * All the benefits of Git (or any VCS) for your DNS zone data. View history. Accept PRs. -* Optimize DNS with [SPF optimizer](functions/record/SPF_BUILDER.md). Detect too many lookups. Flatten includes. +* Optimize DNS with [SPF optimizer](functions/domain/SPF_BUILDER.md). Detect too many lookups. Flatten includes. * Runs on Linux, Windows, Mac, or any operating system supported by Go. * Enable/disable Cloudflare proxying (the "orange cloud" button) directly from your DNSControl files. * [Assign an IP address to a constant](examples.md#variables-for-common-ip-addresses) and use the variable name throughout the configuration. Need to change the IP address globally? Just change the variable and "recompile". diff --git a/documentation/providers.md b/documentation/providers.md index b199925c3..c925152b4 100644 --- a/documentation/providers.md +++ b/documentation/providers.md @@ -187,5 +187,5 @@ DNSControl tries to make writing a provider as easy as possible. DNSControl does most of the work for you, you only have to write code to authenticate, download DNS records, and perform create/modify/delete operations on those records. Please read the directions for [Writing new DNS -providers](/developer-info/writing-providers). The DNS maintainers will gladly +providers](writing-providers.md). The DNS maintainers will gladly coach you through the process. diff --git a/documentation/styleguide-doc.md b/documentation/styleguide-doc.md index 523b39c67..aff60131f 100644 --- a/documentation/styleguide-doc.md +++ b/documentation/styleguide-doc.md @@ -207,7 +207,7 @@ The function `GetRegistrarCorrections()` returns... #### Internal links ```markdown -Blah blah blah [M365_BUILDER](functions/record/M365_BUILDER.md) +Blah blah blah [M365_BUILDER](functions/domain/M365_BUILDER.md) ``` {% hint style="info" %}