GITBOOK-13: change request with no subject merged in GitBook

cafferata · Nov 30, 2023 · 9ca522b · 9ca522b
1 parent d3112f5
commit 9ca522b
Show file tree

Hide file tree

Showing 24 changed files with 325 additions and 342 deletions.
diff --git a/documentation/index.md → documentation/README.md b/documentation/index.md → documentation/README.md
@@ -1,12 +1,14 @@
+# Introduction to DNSControl
+
 {% hint style="info" %}
-<span style="font-size: 21px; font-weight: 200;">DNSControl is an <a href="https://docs.dnscontrol.org/developer-info/opinions">opinionated</a> platform for seamlessly managing your DNS configuration across any number of DNS hosts, both in the cloud or in your own infrastructure. It manages all of the domains for the Stack Overflow network, and can do the same for you!</span>
+DNSControl is an [opinionated](https://docs.dnscontrol.org/developer-info/opinions) platform for seamlessly managing your DNS configuration across any number of DNS hosts, both in the cloud or in your own infrastructure. It manages all of the domains for the Stack Overflow network, and can do the same for you!
 {% endhint %}
 
-# Try It
+## Try It
 
 Want to jump right in? Follow our [quick start tutorial](getting-started.md) on a new domain or [migrate](migrating.md) an existing one. Read the [language spec](js.md) for more info.
 
-# Use It
+## Use It
 
 Take advantage of the advanced features. Use macros and variables for easier updates. Upload your zones to [multiple DNS providers](providers.md).
 
@@ -18,13 +20,13 @@ 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](broken-reference). 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".
 * Keep similar domains in sync with transforms, [macros](examples.md#macro-to-for-repeated-records), and variables.
 {% endhint %}
 
-# Get Involved
+## Get Involved
 
 Join our [mailing list](https://groups.google.com/g/dnscontrol-discuss). We make it easy to contribute by using [GitHub](https://github.com/StackExchange/dnscontrol), you can make code changes with confidence thanks to extensive integration tests. The project is [newbie-friendly](https://everythingsysadmin.com/2017/08/go-get-up-to-speed.html) so jump right in!
diff --git a/documentation/SUMMARY.md b/documentation/SUMMARY.md
@@ -1,6 +1,6 @@
 # Table of contents
 
-* [Introduction to DNSControl](index.md)
+* [Introduction to DNSControl](README.md)
 
 ## Getting Started
 
@@ -13,12 +13,12 @@
 ## Language Reference
 
 * [JavaScript DSL](js.md)
-* Top Level Functions
+* [Top Level Functions](language-reference/top-level-functions/README.md)
   * [D](functions/global/D.md)
   * [DEFAULTS](functions/global/DEFAULTS.md)
-  * [DOMAIN_ELSEWHERE](functions/global/DOMAIN_ELSEWHERE.md)
-  * [DOMAIN_ELSEWHERE_AUTO](functions/global/DOMAIN_ELSEWHERE_AUTO.md)
-  * [D_EXTEND](functions/global/D_EXTEND.md)
+  * [DOMAIN\_ELSEWHERE](functions/global/DOMAIN\_ELSEWHERE.md)
+  * [DOMAIN\_ELSEWHERE\_AUTO](functions/global/DOMAIN\_ELSEWHERE\_AUTO.md)
+  * [D\_EXTEND](functions/global/D\_EXTEND.md)
   * [FETCH](functions/global/FETCH.md)
   * [IP](functions/global/IP.md)
   * [NewDnsProvider](functions/global/NewDnsProvider.md)
@@ -27,120 +27,120 @@
   * [REV](functions/global/REV.md)
   * [getConfiguredDomains](functions/global/getConfiguredDomains.md)
   * [require](functions/global/require.md)
-  * [require_glob](functions/global/require_glob.md)
-* Domain Modifiers
-    * [A](functions/domain/A.md)
-    * [AAAA](functions/domain/AAAA.md)
-    * [ALIAS](functions/domain/ALIAS.md)
-    * [AUTODNSSEC_OFF](functions/domain/AUTODNSSEC_OFF.md)
-    * [AUTODNSSEC_ON](functions/domain/AUTODNSSEC_ON.md)
-    * [CAA](functions/domain/CAA.md)
-    * [CAA_BUILDER](functions/domain/CAA_BUILDER.md)
-    * [CNAME](functions/domain/CNAME.md)
-    * [DISABLE_IGNORE_SAFETY_CHECK](functions/domain/DISABLE_IGNORE_SAFETY_CHECK.md)
-    * [DMARC_BUILDER](functions/domain/DMARC_BUILDER.md)
-    * [DS](functions/domain/DS.md)
-    * [DefaultTTL](functions/domain/DefaultTTL.md)
-    * [DnsProvider](functions/domain/DnsProvider.md)
-    * [FRAME](functions/domain/FRAME.md)
-    * [IGNORE](functions/domain/IGNORE.md)
-    * [IGNORE_NAME](functions/domain/IGNORE_NAME.md)
-    * [IGNORE_TARGET](functions/domain/IGNORE_TARGET.md)
-    * [IMPORT_TRANSFORM](functions/domain/IMPORT_TRANSFORM.md)
-    * [INCLUDE](functions/domain/INCLUDE.md)
-    * [LOC](functions/domain/LOC.md)
-    * [LOC_BUILDER_DD](functions/domain/LOC_BUILDER_DD.md)
-    * [LOC_BUILDER_DMM_STR](functions/domain/LOC_BUILDER_DMM_STR.md)
-    * [LOC_BUILDER_DMS_STR](functions/domain/LOC_BUILDER_DMS_STR.md)
-    * [LOC_BUILDER_STR](functions/domain/LOC_BUILDER_STR.md)
-    * [M365_BUILDER](functions/domain/M365_BUILDER.md)
-    * [MX](functions/domain/MX.md)
-    * [NAMESERVER](functions/domain/NAMESERVER.md)
-    * [NAMESERVER_TTL](functions/domain/NAMESERVER_TTL.md)
-    * [NAPTR](functions/domain/NAPTR.md)
-    * [NO_PURGE](functions/domain/NO_PURGE.md)
-    * [NS](functions/domain/NS.md)
-    * [PTR](functions/domain/PTR.md)
-    * [PURGE](functions/domain/PURGE.md)
-    * [SOA](functions/domain/SOA.md)
-    * [SPF_BUILDER](functions/domain/SPF_BUILDER.md)
-    * [SRV](functions/domain/SRV.md)
-    * [SSHFP](functions/domain/SSHFP.md)
-    * [TLSA](functions/domain/TLSA.md)
-    * [TXT](functions/domain/TXT.md)
-    * [URL](functions/domain/URL.md)
-    * [URL301](functions/domain/URL301.md)
-    * Service Provider specific
-        * Akamai Edge Dns
-            * [AKAMAICDN](functions/domain/AKAMAICDN.md)
-        * Amazon Route 53
-            * [R53_ALIAS](functions/domain/R53_ALIAS.md)
-        * Azure DNS
-            * [AZURE_ALIAS](functions/domain/AZURE_ALIAS.md)
-        * Cloudflare DNS
-            * [CF_REDIRECT](functions/domain/CF_REDIRECT.md)
-            * [CF_TEMP_REDIRECT](functions/domain/CF_TEMP_REDIRECT.md)
-            * [CF_WORKER_ROUTE](functions/domain/CF_WORKER_ROUTE.md)
-        * ClouDNS
-            * [CLOUDNS_WR](functions/domain/CLOUDNS_WR.md)
-        * NS1
-            * [NS1_URLFWD](functions/domain/NS1_URLFWD.md)
-* Record Modifiers
-    * [TTL](functions/record/TTL.md)
-    * Service Provider specific
-        * Amazon Route 53
-            * [R53_ZONE](functions/record/R53_ZONE.md)
-            * [R53_EVALUATE_TARGET_HEALTH](functions/record/R53_EVALUATE_TARGET_HEALTH.md)
+  * [require\_glob](functions/global/require\_glob.md)
+* [Domain Modifiers](language-reference/domain-modifiers/README.md)
+  * [A](functions/domain/A.md)
+  * [AAAA](functions/domain/AAAA.md)
+  * [ALIAS](functions/domain/ALIAS.md)
+  * [AUTODNSSEC\_OFF](functions/domain/AUTODNSSEC\_OFF.md)
+  * [AUTODNSSEC\_ON](functions/domain/AUTODNSSEC\_ON.md)
+  * [CAA](functions/domain/CAA.md)
+  * [CAA\_BUILDER](functions/domain/CAA\_BUILDER.md)
+  * [CNAME](functions/domain/CNAME.md)
+  * [DISABLE\_IGNORE\_SAFETY\_CHECK](functions/domain/DISABLE\_IGNORE\_SAFETY\_CHECK.md)
+  * [DMARC\_BUILDER](functions/domain/DMARC\_BUILDER.md)
+  * [DS](functions/domain/DS.md)
+  * [DefaultTTL](functions/domain/DefaultTTL.md)
+  * [DnsProvider](functions/domain/DnsProvider.md)
+  * [FRAME](functions/domain/FRAME.md)
+  * [IGNORE](functions/domain/IGNORE.md)
+  * [IGNORE\_NAME](functions/domain/IGNORE\_NAME.md)
+  * [IGNORE\_TARGET](functions/domain/IGNORE\_TARGET.md)
+  * [IMPORT\_TRANSFORM](functions/domain/IMPORT\_TRANSFORM.md)
+  * [INCLUDE](functions/domain/INCLUDE.md)
+  * [LOC](functions/domain/LOC.md)
+  * [LOC\_BUILDER\_DD](functions/domain/LOC\_BUILDER\_DD.md)
+  * [LOC\_BUILDER\_DMM\_STR](functions/domain/LOC\_BUILDER\_DMM\_STR.md)
+  * [LOC\_BUILDER\_DMS\_STR](functions/domain/LOC\_BUILDER\_DMS\_STR.md)
+  * [LOC\_BUILDER\_STR](functions/domain/LOC\_BUILDER\_STR.md)
+  * [M365\_BUILDER](functions/domain/M365\_BUILDER.md)
+  * [MX](functions/domain/MX.md)
+  * [NAMESERVER](functions/domain/NAMESERVER.md)
+  * [NAMESERVER\_TTL](functions/domain/NAMESERVER\_TTL.md)
+  * [NAPTR](functions/domain/NAPTR.md)
+  * [NO\_PURGE](functions/domain/NO\_PURGE.md)
+  * [NS](functions/domain/NS.md)
+  * [PTR](functions/domain/PTR.md)
+  * [PURGE](functions/domain/PURGE.md)
+  * [SOA](functions/domain/SOA.md)
+  * [SPF\_BUILDER](functions/domain/SPF\_BUILDER.md)
+  * [SRV](functions/domain/SRV.md)
+  * [SSHFP](functions/domain/SSHFP.md)
+  * [TLSA](functions/domain/TLSA.md)
+  * [TXT](functions/domain/TXT.md)
+  * [URL](functions/domain/URL.md)
+  * [URL301](functions/domain/URL301.md)
+  * [Service Provider specific](language-reference/domain-modifiers/service-provider-specific/README.md)
+    * [Akamai Edge Dns](language-reference/domain-modifiers/service-provider-specific/akamai-edge-dns/README.md)
+      * [AKAMAICDN](functions/domain/AKAMAICDN.md)
+    * [Amazon Route 53](language-reference/domain-modifiers/service-provider-specific/amazon-route-53/README.md)
+      * [R53\_ALIAS](functions/domain/R53\_ALIAS.md)
+    * [Azure DNS](language-reference/domain-modifiers/service-provider-specific/azure-dns/README.md)
+      * [AZURE\_ALIAS](functions/domain/AZURE\_ALIAS.md)
+    * [Cloudflare DNS](language-reference/domain-modifiers/service-provider-specific/cloudflare-dns/README.md)
+      * [CF\_REDIRECT](functions/domain/CF\_REDIRECT.md)
+      * [CF\_TEMP\_REDIRECT](functions/domain/CF\_TEMP\_REDIRECT.md)
+      * [CF\_WORKER\_ROUTE](functions/domain/CF\_WORKER\_ROUTE.md)
+    * [ClouDNS](language-reference/domain-modifiers/service-provider-specific/cloudns/README.md)
+      * [CLOUDNS\_WR](functions/domain/CLOUDNS\_WR.md)
+    * [NS1](language-reference/domain-modifiers/service-provider-specific/ns1/README.md)
+      * [NS1\_URLFWD](functions/domain/NS1\_URLFWD.md)
+* [Record Modifiers](language-reference/record-modifiers/README.md)
+  * [TTL](functions/record/TTL.md)
+  * [Service Provider specific](language-reference/record-modifiers/service-provider-specific/README.md)
+    * [Amazon Route 53](language-reference/record-modifiers/service-provider-specific/amazon-route-53/README.md)
+      * [R53\_ZONE](functions/record/R53\_ZONE.md)
+      * [R53\_EVALUATE\_TARGET\_HEALTH](functions/record/R53\_EVALUATE\_TARGET\_HEALTH.md)
 * [Why CNAME/MX/NS targets require a "dot"](why-the-dot.md)
 
 ## Service Providers
 
 * [Providers](providers.md)
-    * [Akamai Edge DNS](providers/akamaiedgedns.md)
-    * [Amazon Route 53](providers/route53.md)
-    * [AutoDNS](providers/autodns.md)
-    * [AXFR+DDNS](providers/axfrddns.md)
-    * [Azure DNS](providers/azure_dns.md)
-    * [Azure Private DNS](providers/azure_private_dns.md)
-    * [BIND](providers/bind.md)
-    * [Cloudflare](providers/cloudflareapi.md)
-    * [ClouDNS](providers/cloudns.md)
-    * [CSC Global](providers/cscglobal.md)
-    * [deSEC](providers/desec.md)
-    * [DigitalOcean](providers/digitalocean.md)
-    * [DNS Made Easy](providers/dnsmadeeasy.md)
-    * [DNSimple](providers/dnsimple.md)
-    * [DNS-over-HTTPS](providers/dnsoverhttps.md)
-    * [DOMAINNAMESHOP](providers/domainnameshop.md)
-    * [easyname](providers/easyname.md)
-    * [Gandi_v5](providers/gandi_v5.md)
-    * [Gcore](providers/gcore.md)
-    * [Google Cloud DNS](providers/gcloud.md)
-    * [Hetzner DNS Console](providers/hetzner.md)
-    * [HEXONET](providers/hexonet.md)
-    * [hosting.de](providers/hostingde.md)
-    * [Hurricane Electric DNS](providers/hedns.md)
-    * [Internet.bs](providers/internetbs.md)
-    * [INWX](providers/inwx.md)
-    * [Linode](providers/linode.md)
-    * [Loopia](providers/loopia.md)
-    * [LuaDNS](providers/luadns.md)
-    * [Microsoft DNS Server on Microsoft Windows Server](providers/msdns.md)
-    * [Mythic Beasts](providers/mythicbeasts.md)
-    * [Namecheap](providers/namecheap.md)
-    * [Name.com](providers/namedotcom.md)
-    * [Netcup](providers/netcup.md)
-    * [Netlify](providers/netlify.md)
-    * [NS1](providers/ns1.md)
-    * [Oracle Cloud](providers/oracle.md)
-    * [OVH](providers/ovh.md)
-    * [Packetframe](providers/packetframe.md)
-    * [Porkbun](providers/porkbun.md)
-    * [PowerDNS](providers/powerdns.md)
-    * [RWTH DNS-Admin](providers/rwth.md)
-    * [SoftLayer DNS](providers/softlayer.md)
-    * [TransIP](providers/transip.md)
-    * [Vultr](providers/vultr.md)
+  * [Akamai Edge DNS](providers/akamaiedgedns.md)
+  * [Amazon Route 53](providers/route53.md)
+  * [AutoDNS](providers/autodns.md)
+  * [AXFR+DDNS](providers/axfrddns.md)
+  * [Azure DNS](providers/azure\_dns.md)
+  * [Azure Private DNS](providers/azure\_private\_dns.md)
+  * [BIND](providers/bind.md)
+  * [Cloudflare](providers/cloudflareapi.md)
+  * [ClouDNS](providers/cloudns.md)
+  * [CSC Global](providers/cscglobal.md)
+  * [deSEC](providers/desec.md)
+  * [DigitalOcean](providers/digitalocean.md)
+  * [DNS Made Easy](providers/dnsmadeeasy.md)
+  * [DNSimple](providers/dnsimple.md)
+  * [DNS-over-HTTPS](providers/dnsoverhttps.md)
+  * [DOMAINNAMESHOP](providers/domainnameshop.md)
+  * [easyname](providers/easyname.md)
+  * [Gandi\_v5](providers/gandi\_v5.md)
+  * [Gcore](providers/gcore.md)
+  * [Google Cloud DNS](providers/gcloud.md)
+  * [Hetzner DNS Console](providers/hetzner.md)
+  * [HEXONET](providers/hexonet.md)
+  * [hosting.de](providers/hostingde.md)
+  * [Hurricane Electric DNS](providers/hedns.md)
+  * [Internet.bs](providers/internetbs.md)
+  * [INWX](providers/inwx.md)
+  * [Linode](providers/linode.md)
+  * [Loopia](providers/loopia.md)
+  * [LuaDNS](providers/luadns.md)
+  * [Microsoft DNS Server on Microsoft Windows Server](providers/msdns.md)
+  * [Mythic Beasts](providers/mythicbeasts.md)
+  * [Namecheap](providers/namecheap.md)
+  * [Name.com](providers/namedotcom.md)
+  * [Netcup](providers/netcup.md)
+  * [Netlify](providers/netlify.md)
+  * [NS1](providers/ns1.md)
+  * [Oracle Cloud](providers/oracle.md)
+  * [OVH](providers/ovh.md)
+  * [Packetframe](providers/packetframe.md)
+  * [Porkbun](providers/porkbun.md)
+  * [PowerDNS](providers/powerdns.md)
+  * [RWTH DNS-Admin](providers/rwth.md)
+  * [SoftLayer DNS](providers/softlayer.md)
+  * [TransIP](providers/transip.md)
+  * [Vultr](providers/vultr.md)
 
 ## Commands