From 12a72cb72923f9dec040f0d270d1ab1b432f85f8 Mon Sep 17 00:00:00 2001 From: Tom Limoncelli Date: Mon, 16 Sep 2024 20:21:59 -0400 Subject: [PATCH] DOCS: Minor clarifications on NAMESERVER() (#3113) --- .gitignore | 2 +- commands/types/dnscontrol.d.ts | 9 +++++---- .../language-reference/domain-modifiers/NAMESERVER.md | 9 +++++---- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index 88410ef51..aaa4741e0 100644 --- a/.gitignore +++ b/.gitignore @@ -23,7 +23,7 @@ stack.sh .idea/ *.nupkg .DS_Store -.vscode/launch.json +.vscode .jekyll-cache types-dnscontrol.d.ts diff --git a/commands/types/dnscontrol.d.ts b/commands/types/dnscontrol.d.ts index a4ae60f37..b540c3f5f 100644 --- a/commands/types/dnscontrol.d.ts +++ b/commands/types/dnscontrol.d.ts @@ -1909,20 +1909,21 @@ declare function M365_BUILDER(opts: { label?: string; mx?: boolean; autodiscover declare function MX(name: string, priority: number, target: string, ...modifiers: RecordModifier[]): DomainModifier; /** - * `NAMESERVER()` instructs DNSControl to inform the domain"s registrar where to find this zone. + * `NAMESERVER()` instructs DNSControl to inform the domain's registrar where to find this zone. * For some registrars this will also add NS records to the zone itself. * * This takes exactly one argument: the name of the nameserver. It must end with * a "." if it is a FQDN, just like all targets. * * This is different than the [`NS()`](NS.md) function, which inserts NS records - * in the current zone and accepts a label. [`NS()`](NS.md) is useful for downward + * in the current zone and accepts a label. [`NS()`](NS.md) is for downward * delegations. `NAMESERVER()` is for informing upstream delegations. * * For more information, refer to [this page](../../nameservers.md). * * ```javascript - * D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER), + * D("example.com", REG_MY_PROVIDER, + * DnsProvider(DSP_MY_PROVIDER), * DnsProvider(route53, 0), * // Replace the nameservers: * NAMESERVER("ns1.myserver.com."), @@ -1941,7 +1942,7 @@ declare function MX(name: string, priority: number, target: string, ...modifiers * Nameservers are one of the least * understood parts of DNS, so a little extra explanation is required. * - * * [`NS()`](NS.md) lets you add an NS record to a zone, just like [`A()`](A.md) adds an A + * * [`NS()`](NS.md) adds an NS record to a zone, just like [`A()`](A.md) adds an A * record to the zone. This is generally used to delegate a subzone. * * * The `NAMESERVER()` directive speaks to the Registrar about how the parent should delegate the zone. diff --git a/documentation/language-reference/domain-modifiers/NAMESERVER.md b/documentation/language-reference/domain-modifiers/NAMESERVER.md index 24c4ee824..354273e94 100644 --- a/documentation/language-reference/domain-modifiers/NAMESERVER.md +++ b/documentation/language-reference/domain-modifiers/NAMESERVER.md @@ -8,21 +8,22 @@ parameter_types: "modifiers...": RecordModifier[] --- -`NAMESERVER()` instructs DNSControl to inform the domain"s registrar where to find this zone. +`NAMESERVER()` instructs DNSControl to inform the domain's registrar where to find this zone. For some registrars this will also add NS records to the zone itself. This takes exactly one argument: the name of the nameserver. It must end with a "." if it is a FQDN, just like all targets. This is different than the [`NS()`](NS.md) function, which inserts NS records -in the current zone and accepts a label. [`NS()`](NS.md) is useful for downward +in the current zone and accepts a label. [`NS()`](NS.md) is for downward delegations. `NAMESERVER()` is for informing upstream delegations. For more information, refer to [this page](../../nameservers.md). {% code title="dnsconfig.js" %} ```javascript -D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER), +D("example.com", REG_MY_PROVIDER, + DnsProvider(DSP_MY_PROVIDER), DnsProvider(route53, 0), // Replace the nameservers: NAMESERVER("ns1.myserver.com."), @@ -43,7 +44,7 @@ END); Nameservers are one of the least understood parts of DNS, so a little extra explanation is required. -* [`NS()`](NS.md) lets you add an NS record to a zone, just like [`A()`](A.md) adds an A +* [`NS()`](NS.md) adds an NS record to a zone, just like [`A()`](A.md) adds an A record to the zone. This is generally used to delegate a subzone. * The `NAMESERVER()` directive speaks to the Registrar about how the parent should delegate the zone.