Skip to content

Commit

Permalink
DOCS: Simplified the provider URLs (providers) (#2914)
Browse files Browse the repository at this point in the history
  • Loading branch information
cafferata committed Apr 18, 2024
1 parent 0cd3c2f commit 5078927
Show file tree
Hide file tree
Showing 67 changed files with 220 additions and 168 deletions.
2 changes: 1 addition & 1 deletion build/generate/featureMatrix.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func markdownTable(matrix *FeatureMatrix) (string, error) {
featureMap := matrix.Providers[providerName]

var tableDataRow []string
tableDataRow = append(tableDataRow, "[`"+providerName+"`](providers/"+strings.ToLower(providerName)+".md)")
tableDataRow = append(tableDataRow, "[`"+providerName+"`](provider/"+strings.ToLower(providerName)+".md)")
for _, featureName := range matrix.Features {
tableDataRow = append(tableDataRow, featureEmoji(featureMap, featureName))
}
Expand Down
4 changes: 2 additions & 2 deletions commands/types/dnscontrol.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2407,7 +2407,7 @@ declare function R53_EVALUATE_TARGET_HEALTH(enabled: boolean): RecordModifier;
/**
* `R53_ZONE` lets you specify the AWS Zone ID for an entire domain ([`D()`](../top-level-functions/D.md)) or a specific [`R53_ALIAS()`](../domain-modifiers/R53_ALIAS.md) record.
*
* When used with [`D()`](../top-level-functions/D.md), it sets the zone id of the domain. This can be used to differentiate between split horizon domains in public and private zones. See this [example](../../providers/route53.md#split-horizon) in the [Amazon Route 53 provider page](../../providers/route53.md).
* When used with [`D()`](../top-level-functions/D.md), it sets the zone id of the domain. This can be used to differentiate between split horizon domains in public and private zones. See this [example](../../provider/route53.md#split-horizon) in the [Amazon Route 53 provider page](../../provider/route53.md).
*
* When used with [`R53_ALIAS()`](../domain-modifiers/R53_ALIAS.md) it sets the required Route53 hosted zone id in a R53_ALIAS record. See [`R53_ALIAS()`](../domain-modifiers/R53_ALIAS.md) documentation for details.
*
Expand Down Expand Up @@ -2546,7 +2546,7 @@ declare function REVCOMPAT(rfc: string): string;
* * Most providers automatically generate SOA records. They will ignore any `SOA()` statements.
* * The mbox field should not be set to a real email address unless you love spam and hate your privacy.
*
* There is more info about `SOA` in the documentation for the [BIND provider](../../providers/bind.md).
* There is more info about `SOA` in the documentation for the [BIND provider](../../provider/bind.md).
*
* @see https://docs.dnscontrol.org/language-reference/domain-modifiers/soa
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/_layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<ul class="nav navbar-nav navbar-right">
<li><a class="hidden-xs" href="https://docs.dnscontrol.org/getting-started/getting-started">Getting Started</a></li>
<li><a class="hidden-xs" href="https://docs.dnscontrol.org/language-reference/js">Language Reference</a></li>
<li><a class="hidden-xs" href="https://docs.dnscontrol.org/service-providers/providers">Providers</a></li>
<li><a class="hidden-xs" href="https://docs.dnscontrol.org/provider">Providers</a></li>
<li><a class="visible-xs" href="https://docs.dnscontrol.org/getting-started/getting-started">Getting Started</a></li>
<li><a class="visible-xs" href="{{site.github.url}}/#reference">Reference</a></li>
<li><a class="visible-xs" href="{{site.github.url}}/#advanced-features">Advanced features</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ title: DNSControl
Use macros and variables for easier updates.
<!-- Optimize your SPF records. -->
Upload your zones to
<strong><a href="https://docs.dnscontrol.org/service-providers/providers">multiple DNS providers</a></strong>.
<strong><a href="https://docs.dnscontrol.org/provider">multiple DNS providers</a></strong>.
</p>
</div>

Expand Down Expand Up @@ -85,7 +85,7 @@ title: DNSControl
<a href="https://docs.dnscontrol.org/getting-started/getting-started">Getting Started</a>: A walk-through of the basics
</li>
<li>
<a href="https://docs.dnscontrol.org/service-providers/providers">Providers</a>: Which DNS providers are supported
<a href="https://docs.dnscontrol.org/provider">Providers</a>: Which DNS providers are supported
</li>
<li>
<a href="https://docs.dnscontrol.org/getting-started/examples">Examples</a>: The DNSControl language by example
Expand Down
52 changes: 52 additions & 0 deletions documentation/.gitbook.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
redirects:
service-providers/providers: providers.md
service-providers/providers/akamaiedgedns: provider/akamaiedgedns.md
service-providers/providers/autodns: provider/autodns.md
service-providers/providers/axfrddns: provider/axfrddns.md
service-providers/providers/azure_dns: provider/azure_dns.md
service-providers/providers/azure_private_dns: provider/azure_private_dns.md
service-providers/providers/bind: provider/bind.md
service-providers/providers/bunny_dns: provider/bunny_dns.md
service-providers/providers/cloudflareapi: provider/cloudflareapi.md
service-providers/providers/cloudns: provider/cloudns.md
service-providers/providers/cscglobal: provider/cscglobal.md
service-providers/providers/desec: provider/desec.md
service-providers/providers/digitalocean: provider/digitalocean.md
service-providers/providers/dnsimple: provider/dnsimple.md
service-providers/providers/dnsmadeeasy: provider/dnsmadeeasy.md
service-providers/providers/dnsoverhttps: provider/dnsoverhttps.md
service-providers/providers/domainnameshop: provider/domainnameshop.md
service-providers/providers/dynadot: provider/dynadot.md
service-providers/providers/easyname: provider/easyname.md
service-providers/providers/exoscale: provider/exoscale.md
service-providers/providers/gandi_v5: provider/gandi_v5.md
service-providers/providers/gcloud: provider/gcloud.md
service-providers/providers/gcore: provider/gcore.md
service-providers/providers/hedns: provider/hedns.md
service-providers/providers/hetzner: provider/hetzner.md
service-providers/providers/hexonet: provider/hexonet.md
service-providers/providers/hostingde: provider/hostingde.md
service-providers/providers/internetbs: provider/internetbs.md
service-providers/providers/inwx: provider/inwx.md
service-providers/providers/linode: provider/linode.md
service-providers/providers/loopia: provider/loopia.md
service-providers/providers/luadns: provider/luadns.md
service-providers/providers/msdns: provider/msdns.md
service-providers/providers/mythicbeasts: provider/mythicbeasts.md
service-providers/providers/namecheap: provider/namecheap.md
service-providers/providers/namedotcom: provider/namedotcom.md
service-providers/providers/netcup: provider/netcup.md
service-providers/providers/netlify: provider/netlify.md
service-providers/providers/ns1: provider/ns1.md
service-providers/providers/opensrs: provider/opensrs.md
service-providers/providers/oracle: provider/oracle.md
service-providers/providers/ovh: provider/ovh.md
service-providers/providers/packetframe: provider/packetframe.md
service-providers/providers/porkbun: provider/porkbun.md
service-providers/providers/powerdns: provider/powerdns.md
service-providers/providers/realtimeregister: provider/realtimeregister.md
service-providers/providers/route53: provider/route53.md
service-providers/providers/rwth: provider/rwth.md
service-providers/providers/softlayer: provider/softlayer.md
service-providers/providers/transip: provider/transip.md
service-providers/providers/vultr: provider/vultr.md
104 changes: 52 additions & 52 deletions documentation/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* [Examples](examples.md)
* [Migrating zones to DNSControl](migrating.md)
* [TypeScript autocomplete and type checking](typescript.md)
* [Providers](providers.md)

## Language Reference

Expand Down Expand Up @@ -94,59 +95,58 @@
* [R53_EVALUATE_TARGET_HEALTH](language-reference/record-modifiers/R53\_EVALUATE\_TARGET\_HEALTH.md)
* [Why CNAME/MX/NS targets require a "dot"](why-the-dot.md)

## Service Providers
## Provider

* [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)
* [Bunny DNS](providers/bunny\_dns.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)
* [Dynadot](providers/dynadot.md)
* [easyname](providers/easyname.md)
* [Exoscale](providers/exoscale.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)
* [OpenSRS](providers/opensrs.md)
* [Oracle Cloud](providers/oracle.md)
* [OVH](providers/ovh.md)
* [Packetframe](providers/packetframe.md)
* [Porkbun](providers/porkbun.md)
* [PowerDNS](providers/powerdns.md)
* [Realtime Register](providers/realtimeregister.md)
* [RWTH DNS-Admin](providers/rwth.md)
* [SoftLayer DNS](providers/softlayer.md)
* [TransIP](providers/transip.md)
* [Vultr](providers/vultr.md)
* [Akamai Edge DNS](provider/akamaiedgedns.md)
* [Amazon Route 53](provider/route53.md)
* [AutoDNS](provider/autodns.md)
* [AXFR+DDNS](provider/axfrddns.md)
* [Azure DNS](provider/azure_dns.md)
* [Azure Private DNS](provider/azure_private_dns.md)
* [BIND](provider/bind.md)
* [Bunny DNS](provider/bunny\_dns.md)
* [Cloudflare](provider/cloudflareapi.md)
* [ClouDNS](provider/cloudns.md)
* [CSC Global](provider/cscglobal.md)
* [deSEC](provider/desec.md)
* [DigitalOcean](provider/digitalocean.md)
* [DNS Made Easy](provider/dnsmadeeasy.md)
* [DNSimple](provider/dnsimple.md)
* [DNS-over-HTTPS](provider/dnsoverhttps.md)
* [DOMAINNAMESHOP](provider/domainnameshop.md)
* [Dynadot](provider/dynadot.md)
* [easyname](provider/easyname.md)
* [Exoscale](provider/exoscale.md)
* [Gandi_v5](provider/gandi_v5.md)
* [Gcore](provider/gcore.md)
* [Google Cloud DNS](provider/gcloud.md)
* [Hetzner DNS Console](provider/hetzner.md)
* [HEXONET](provider/hexonet.md)
* [hosting.de](provider/hostingde.md)
* [Hurricane Electric DNS](provider/hedns.md)
* [Internet.bs](provider/internetbs.md)
* [INWX](provider/inwx.md)
* [Linode](provider/linode.md)
* [Loopia](provider/loopia.md)
* [LuaDNS](provider/luadns.md)
* [Microsoft DNS Server on Microsoft Windows Server](provider/msdns.md)
* [Mythic Beasts](provider/mythicbeasts.md)
* [Namecheap](provider/namecheap.md)
* [Name.com](provider/namedotcom.md)
* [Netcup](provider/netcup.md)
* [Netlify](provider/netlify.md)
* [NS1](provider/ns1.md)
* [OpenSRS](provider/opensrs.md)
* [Oracle Cloud](provider/oracle.md)
* [OVH](provider/ovh.md)
* [Packetframe](provider/packetframe.md)
* [Porkbun](provider/porkbun.md)
* [PowerDNS](provider/powerdns.md)
* [Realtime Register](provider/realtimeregister.md)
* [RWTH DNS-Admin](provider/rwth.md)
* [SoftLayer DNS](provider/softlayer.md)
* [TransIP](provider/transip.md)
* [Vultr](provider/vultr.md)

## Commands

Expand Down
4 changes: 2 additions & 2 deletions documentation/adding-new-rtypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,14 @@ a minimum.
- Run stringer to auto-update the file `dnscontrol/providers/capability_string.go`

```shell
pushd; cd providers/;
pushd; cd provider/;
stringer -type=Capability
popd
```
alternatively

```shell
pushd; cd providers/;
pushd; cd provider/;
go generate
popd
```
Expand Down
2 changes: 1 addition & 1 deletion documentation/bug-triage.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Message to requester:
Thank you for requesting this provider!
I've tagged this issue as a provider-request. It will (soon) be listed as a "requested provider" on the provider list web page:
https://docs.dnscontrol.org/service-providers/providers
https://docs.dnscontrol.org/provider
I will now close the issue. I know that's a bit confusing, but it will remain on the "requested provider" list.
Expand Down
2 changes: 1 addition & 1 deletion documentation/get-zones.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,4 +192,4 @@ provider.)
Implementing the `ListZones` function also activates the `check-creds`
subcommand for that provider. Please add to the provider documentation
a list of error messages that people might see if the credentials are
invalid. See `documentation/providers/gcloud.md` for examples.
invalid. See `documentation/provider/gcloud.md` for examples.
2 changes: 1 addition & 1 deletion documentation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ $TTL 300
```

You can change the "DEFAULT_NOT_SET" text by following the documentation
for the [BIND provider](providers/bind.md) to set
for the [BIND provider](provider/bind.md) to set
the "master" and "mbox" settings. Try that now.


Expand Down
2 changes: 1 addition & 1 deletion documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Take advantage of the advanced features. Use macros and variables for easier upd
* Super extensible! Plug-in architecture makes adding new DNS providers and Registrars easy!
* Eliminate vendor lock-in. Switch DNS providers easily, any time, with full fidelity.
* Reduce points of failure: Easily maintain dual DNS providers and easily drop one that is down.
* 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).
* Supports 35+ [DNS Providers](providers.md) including [BIND](provider/bind.md), [AWS Route 53](provider/route53.md), [Google DNS](provider/gcloud.md), and [name.com](provider/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](language-reference/domain-modifiers/SPF_BUILDER.md). Detect too many lookups. Flatten includes.
Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/SOA.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ when you are making it easier for spammers how to find you.
* Most providers automatically generate SOA records. They will ignore any `SOA()` statements.
* The mbox field should not be set to a real email address unless you love spam and hate your privacy.

There is more info about `SOA` in the documentation for the [BIND provider](../../providers/bind.md).
There is more info about `SOA` in the documentation for the [BIND provider](../../provider/bind.md).
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ provider: ROUTE53

`R53_ZONE` lets you specify the AWS Zone ID for an entire domain ([`D()`](../top-level-functions/D.md)) or a specific [`R53_ALIAS()`](../domain-modifiers/R53_ALIAS.md) record.

When used with [`D()`](../top-level-functions/D.md), it sets the zone id of the domain. This can be used to differentiate between split horizon domains in public and private zones. See this [example](../../providers/route53.md#split-horizon) in the [Amazon Route 53 provider page](../../providers/route53.md).
When used with [`D()`](../top-level-functions/D.md), it sets the zone id of the domain. This can be used to differentiate between split horizon domains in public and private zones. See this [example](../../provider/route53.md#split-horizon) in the [Amazon Route 53 provider page](../../provider/route53.md).

When used with [`R53_ALIAS()`](../domain-modifiers/R53_ALIAS.md) it sets the required Route53 hosted zone id in a R53_ALIAS record. See [`R53_ALIAS()`](../domain-modifiers/R53_ALIAS.md) documentation for details.
2 changes: 1 addition & 1 deletion documentation/nameservers.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ a notified if the delegation diverges.
Why?
Sometimes you just want to know if something changes!

See the [DNS-over-HTTPS Provider](providers/dnsoverhttps.md) documentation for more info.
See the [DNS-over-HTTPS Provider](provider/dnsoverhttps.md) documentation for more info.

{% code title="dnsconfig.js" %}
```javascript
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 5078927

Please sign in to comment.