Skip to content

Commit

Permalink
DOCS: fix broken links (#3437)
Browse files Browse the repository at this point in the history
  • Loading branch information
imlonghao authored Feb 17, 2025
1 parent e91289b commit e0e32ca
Show file tree
Hide file tree
Showing 10 changed files with 82 additions and 82 deletions.
32 changes: 16 additions & 16 deletions build/generate/featureMatrix.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,22 +76,22 @@ func matrixData() *FeatureMatrix {
ProviderDNSProvider = "DNS Provider"
ProviderRegistrar = "Registrar"
ProviderThreadSafe = "Concurrency Verified"
DomainModifierAlias = "[`ALIAS`](language-reference/domain-modifiers/ALIAS.md)"
DomainModifierCaa = "[`CAA`](language-reference/domain-modifiers/CAA.md)"
DomainModifierDnssec = "[`AUTODNSSEC`](language-reference/domain-modifiers/AUTODNSSEC_ON.md)"
DomainModifierHTTPS = "[`HTTPS`](language-reference/domain-modifiers/HTTPS.md)"
DomainModifierLoc = "[`LOC`](language-reference/domain-modifiers/LOC.md)"
DomainModifierNaptr = "[`NAPTR`](language-reference/domain-modifiers/NAPTR.md)"
DomainModifierPtr = "[`PTR`](language-reference/domain-modifiers/PTR.md)"
DomainModifierSoa = "[`SOA`](language-reference/domain-modifiers/SOA.md)"
DomainModifierSrv = "[`SRV`](language-reference/domain-modifiers/SRV.md)"
DomainModifierSshfp = "[`SSHFP`](language-reference/domain-modifiers/SSHFP.md)"
DomainModifierSvcb = "[`SVCB`](language-reference/domain-modifiers/SVCB.md)"
DomainModifierTlsa = "[`TLSA`](language-reference/domain-modifiers/TLSA.md)"
DomainModifierDs = "[`DS`](language-reference/domain-modifiers/DS.md)"
DomainModifierDhcid = "[`DHCID`](language-reference/domain-modifiers/DHCID.md)"
DomainModifierDname = "[`DNAME`](language-reference/domain-modifiers/DNAME.md)"
DomainModifierDnskey = "[`DNSKEY`](language-reference/domain-modifiers/DNSKEY.md)"
DomainModifierAlias = "[`ALIAS`](../language-reference/domain-modifiers/ALIAS.md)"
DomainModifierCaa = "[`CAA`](../language-reference/domain-modifiers/CAA.md)"
DomainModifierDnssec = "[`AUTODNSSEC`](../language-reference/domain-modifiers/AUTODNSSEC_ON.md)"
DomainModifierHTTPS = "[`HTTPS`](../language-reference/domain-modifiers/HTTPS.md)"
DomainModifierLoc = "[`LOC`](../language-reference/domain-modifiers/LOC.md)"
DomainModifierNaptr = "[`NAPTR`](../language-reference/domain-modifiers/NAPTR.md)"
DomainModifierPtr = "[`PTR`](../language-reference/domain-modifiers/PTR.md)"
DomainModifierSoa = "[`SOA`](../language-reference/domain-modifiers/SOA.md)"
DomainModifierSrv = "[`SRV`](../language-reference/domain-modifiers/SRV.md)"
DomainModifierSshfp = "[`SSHFP`](../language-reference/domain-modifiers/SSHFP.md)"
DomainModifierSvcb = "[`SVCB`](../language-reference/domain-modifiers/SVCB.md)"
DomainModifierTlsa = "[`TLSA`](../language-reference/domain-modifiers/TLSA.md)"
DomainModifierDs = "[`DS`](../language-reference/domain-modifiers/DS.md)"
DomainModifierDhcid = "[`DHCID`](../language-reference/domain-modifiers/DHCID.md)"
DomainModifierDname = "[`DNAME`](../language-reference/domain-modifiers/DNAME.md)"
DomainModifierDnskey = "[`DNSKEY`](../language-reference/domain-modifiers/DNSKEY.md)"
DualHost = "dual host"
CreateDomains = "create-domains"
GetZones = "get-zones"
Expand Down
10 changes: 5 additions & 5 deletions commands/types/dnscontrol.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ declare function A(name: string, address: string | number, ...modifiers: RecordM
declare function AAAA(name: string, address: string, ...modifiers: RecordModifier[]): DomainModifier;

/**
* AKAMAICDN is a proprietary record type that is used to configure [Zone Apex Mapping](https://blogs.akamai.com/2019/08/fast-dns-zone-apex-mapping-dnssec.html).
* AKAMAICDN is a proprietary record type that is used to configure [Zone Apex Mapping](https://www.akamai.com/blog/security/edge-dns--zone-apex-mapping---dnssec).
* The AKAMAICDN target must be preconfigured in the Akamai network.
*
* @see https://docs.dnscontrol.org/language-reference/domain-modifiers/service-provider-specific/akamai-edge-dns/akamaicdn
Expand Down Expand Up @@ -475,7 +475,7 @@ declare function CAA_BUILDER(opts: { label?: string; iodef: string; iodef_critic
* WARNING: Cloudflare is removing this feature and replacing it with a new
* feature called "Dynamic Single Redirect". DNSControl will automatically
* generate "Dynamic Single Redirects" for a limited number of use cases. See
* [`CLOUDFLAREAPI`](../provider/cloudflareapi.md) for details.
* [`CLOUDFLAREAPI`](../../provider/cloudflareapi.md) for details.
*
* `CF_REDIRECT` uses Cloudflare-specific features ("Forwarding URL" Page Rules) to
* generate a HTTP 301 permanent redirect.
Expand Down Expand Up @@ -541,7 +541,7 @@ declare function CF_SINGLE_REDIRECT(name: string, code: number, when: string, th
* WARNING: Cloudflare is removing this feature and replacing it with a new
* feature called "Dynamic Single Redirect". DNSControl will automatically
* generate "Dynamic Single Redirects" for a limited number of use cases. See
* [`CLOUDFLAREAPI`](../provider/cloudflareapi.md) for details.
* [`CLOUDFLAREAPI`](../../provider/cloudflareapi.md) for details.
*
* `CF_TEMP_REDIRECT` uses Cloudflare-specific features ("Forwarding URL" Page
* Rules) to generate a HTTP 302 temporary redirect.
Expand Down Expand Up @@ -2484,7 +2484,7 @@ declare function PORKBUN_URLFWD(name: string, target: string, ...modifiers: Reco
*
* DNSControl does not automatically generate forward and reverse lookups. However
* it is possible to write a macro that does this by using the
* [`D_EXTEND()`](../global/D_EXTEND.md)
* [`D_EXTEND()`](../top-level-functions/D_EXTEND.md)
* function to insert `A` and `PTR` records into previously-defined domains.
*
* ```javascript
Expand Down Expand Up @@ -2678,7 +2678,7 @@ declare function R53_ZONE(zone_id: string): DomainModifier & RecordModifier;
*
* DNSControl does not automatically generate forward and reverse lookups. However
* it is possible to write a macro that does this. See
* [`PTR()`](../domain/PTR.md) for an example.
* [`PTR()`](../domain-modifiers/PTR.md) for an example.
*
* @see https://docs.dnscontrol.org/language-reference/top-level-functions/rev
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ parameter_types:
"modifiers...": RecordModifier[]
---

AKAMAICDN is a proprietary record type that is used to configure [Zone Apex Mapping](https://blogs.akamai.com/2019/08/fast-dns-zone-apex-mapping-dnssec.html).
AKAMAICDN is a proprietary record type that is used to configure [Zone Apex Mapping](https://www.akamai.com/blog/security/edge-dns--zone-apex-mapping---dnssec).
The AKAMAICDN target must be preconfigured in the Akamai network.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ parameter_types:
WARNING: Cloudflare is removing this feature and replacing it with a new
feature called "Dynamic Single Redirect". DNSControl will automatically
generate "Dynamic Single Redirects" for a limited number of use cases. See
[`CLOUDFLAREAPI`](../provider/cloudflareapi.md) for details.
[`CLOUDFLAREAPI`](../../provider/cloudflareapi.md) for details.
{% endhint %}

`CF_REDIRECT` uses Cloudflare-specific features ("Forwarding URL" Page Rules) to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ parameter_types:
**WARNING**: Cloudflare is removing this feature and replacing it with a new
feature called "Dynamic Single Redirect". DNSControl will automatically
generate "Dynamic Single Redirects" for a limited number of use cases. See
[`CLOUDFLAREAPI`](../provider/cloudflareapi.md) for details.
[`CLOUDFLAREAPI`](../../provider/cloudflareapi.md) for details.
{% endhint %}

`CF_TEMP_REDIRECT` uses Cloudflare-specific features ("Forwarding URL" Page
Expand Down
2 changes: 1 addition & 1 deletion documentation/language-reference/domain-modifiers/PTR.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ D(REV("2001:db8:302::/48"), REGISTRAR, DnsProvider(BIND),

DNSControl does not automatically generate forward and reverse lookups. However
it is possible to write a macro that does this by using the
[`D_EXTEND()`](../global/D_EXTEND.md)
[`D_EXTEND()`](../top-level-functions/D_EXTEND.md)
function to insert `A` and `PTR` records into previously-defined domains.

{% code title="dnsconfig.js" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,4 @@ D(REV("2001:db8:302::/48"), REGISTRAR, DnsProvider(BIND),
DNSControl does not automatically generate forward and reverse lookups. However
it is possible to write a macro that does this. See
[`PTR()`](../domain/PTR.md) for an example.
[`PTR()`](../domain-modifiers/PTR.md) for an example.
2 changes: 1 addition & 1 deletion documentation/provider/cloudflareapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ This method is enabled by setting the `apitoken` value in `creds.json`:
{% endcode %}

* `accountid` is found in the Cloudflare portal ("Account ID") on any "Website" page. Click on any site and you'll see the "Account ID" on the lower right side of the page.
* `apitoken` is something you must create. See [Cloudflare's documentation](https://support.cloudflare.com/hc/en-us/articles/200167836-Managing-API-Tokens-and-Keys) for instructions on how to generate and configure permissions on API tokens. (Spoiler alert: [link](https://dash.cloudflare.com/profile/api-tokens). The token must be granted rights (authorization to do certain tasks) at a very granular level.
* `apitoken` is something you must create. See [Cloudflare's documentation](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) for instructions on how to generate and configure permissions on API tokens. (Spoiler alert: [link](https://dash.cloudflare.com/profile/api-tokens). The token must be granted rights (authorization to do certain tasks) at a very granular level.

DNSControl requires the token to have the following permissions:

Expand Down
108 changes: 54 additions & 54 deletions documentation/provider/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ a provider that supports it, we'd love your contribution to ensure it works corr
If a feature is definitively not supported for whatever reason, we would also like a PR to clarify why it is not supported, and fill in this entire matrix.

<!-- provider-matrix-start -->
| Provider name | Official Support | DNS Provider | Registrar | Concurrency Verified | [`ALIAS`](language-reference/domain-modifiers/ALIAS.md) | [`CAA`](language-reference/domain-modifiers/CAA.md) | [`AUTODNSSEC`](language-reference/domain-modifiers/AUTODNSSEC_ON.md) | [`HTTPS`](language-reference/domain-modifiers/HTTPS.md) | [`LOC`](language-reference/domain-modifiers/LOC.md) | [`NAPTR`](language-reference/domain-modifiers/NAPTR.md) | [`PTR`](language-reference/domain-modifiers/PTR.md) | [`SOA`](language-reference/domain-modifiers/SOA.md) | [`SRV`](language-reference/domain-modifiers/SRV.md) | [`SSHFP`](language-reference/domain-modifiers/SSHFP.md) | [`SVCB`](language-reference/domain-modifiers/SVCB.md) | [`TLSA`](language-reference/domain-modifiers/TLSA.md) | [`DS`](language-reference/domain-modifiers/DS.md) | [`DHCID`](language-reference/domain-modifiers/DHCID.md) | [`DNAME`](language-reference/domain-modifiers/DNAME.md) | [`DNSKEY`](language-reference/domain-modifiers/DNSKEY.md) | dual host | create-domains | get-zones |
| ------------- | ---------------- | ------------ | --------- | -------------------- | ------------------------------------------------------- | --------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------- | --------------------------------------------------- | ------------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | ------------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | --------------------------------------------------------- | --------- | -------------- | --------- |
| Provider name | Official Support | DNS Provider | Registrar | Concurrency Verified | [`ALIAS`](../language-reference/domain-modifiers/ALIAS.md) | [`CAA`](../language-reference/domain-modifiers/CAA.md) | [`AUTODNSSEC`](../language-reference/domain-modifiers/AUTODNSSEC_ON.md) | [`HTTPS`](../language-reference/domain-modifiers/HTTPS.md) | [`LOC`](../language-reference/domain-modifiers/LOC.md) | [`NAPTR`](../language-reference/domain-modifiers/NAPTR.md) | [`PTR`](../language-reference/domain-modifiers/PTR.md) | [`SOA`](../language-reference/domain-modifiers/SOA.md) | [`SRV`](../language-reference/domain-modifiers/SRV.md) | [`SSHFP`](../language-reference/domain-modifiers/SSHFP.md) | [`SVCB`](../language-reference/domain-modifiers/SVCB.md) | [`TLSA`](../language-reference/domain-modifiers/TLSA.md) | [`DS`](../language-reference/domain-modifiers/DS.md) | [`DHCID`](../language-reference/domain-modifiers/DHCID.md) | [`DNAME`](../language-reference/domain-modifiers/DNAME.md) | [`DNSKEY`](../language-reference/domain-modifiers/DNSKEY.md) | dual host | create-domains | get-zones |
| ------------- | ---------------- | ------------ | --------- | -------------------- | ---------------------------------------------------------- | ------------------------------------------------------ | ----------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------ | ---------------------------------------------------------- | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ---------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | --------- | -------------- | --------- |
| [`AKAMAIEDGEDNS`](akamaiedgedns.md) ||||||||||||||||||||||||
| [`AUTODNS`](autodns.md) ||||||||||||||||||||||||
| [`AXFRDDNS`](axfrddns.md) ||||||||||||||||||||||||
Expand Down Expand Up @@ -82,13 +82,13 @@ Providers in this category and their maintainers are:

|Name|Maintainer|
|---|---|
|[`AZURE_DNS`](provider/azure_dns.md)|@vatsalyagoel|
|[`BIND`](provider/bind.md)|@tlimoncelli|
|[`CLOUDFLAREAPI`](provider/cloudflareapi.md)|@tresni|
|[`CSCGLOBAL`](provider/cscglobal.md)|@mikenz|
|[`GCLOUD`](provider/gcloud.md)|@riyadhalnur|
|[`MSDNS`](provider/msdns.md)|@tlimoncelli|
|[`ROUTE53`](provider/route53.md)|@tresni|
|[`AZURE_DNS`](azure_dns.md)|@vatsalyagoel|
|[`BIND`](bind.md)|@tlimoncelli|
|[`CLOUDFLAREAPI`](cloudflareapi.md)|@tresni|
|[`CSCGLOBAL`](cscglobal.md)|@mikenz|
|[`GCLOUD`](gcloud.md)|@riyadhalnur|
|[`MSDNS`](msdns.md)|@tlimoncelli|
|[`ROUTE53`](route53.md)|@tresni|

### Providers with "contributor support"

Expand All @@ -112,50 +112,50 @@ Providers in this category and their maintainers are:

|Name|Maintainer|
|---|---|
|[`AZURE_PRIVATE_DNS`](provider/azure_private_dns.md)|@matthewmgamble|
|[`AKAMAIEDGEDNS`](provider/akamaiedgedns.md)|@edglynes|
|[`AXFRDDNS`](provider/axfrddns.md)|@hnrgrgr|
|[`BUNNY_DNS`](provider/bunny_dns.md)|@ppmathis|
|[`CLOUDFLAREAPI`](provider/cloudflareapi.md)|@tresni|
|[`CLOUDNS`](provider/cloudns.md)|@pragmaton|
|[`CNR`](provider/cnr.md)|@KaiSchwarz-cnic|
|[`CSCGLOBAL`](provider/cscglobal.md)|@Air-New-Zealand|
|[`DESEC`](provider/desec.md)|@D3luxee|
|[`DIGITALOCEAN`](provider/digitalocean.md)|@Deraen|
|[`DNSIMPLE`](provider/dnsimple.md)|@onlyhavecans|
|[`DNSMADEEASY`](provider/dnsmadeeasy.md)|@vojtad|
|[`DNSOVERHTTPS`](provider/dnsoverhttps.md)|@mikenz|
|[`DOMAINNAMESHOP`](provider/domainnameshop.md)|@SimenBai|
|[`EASYNAME`](provider/easyname.md)|@tresni|
|[`EXOSCALE`](provider/exoscale.md)|@pierre-emmanuelJ|
|[`GANDI_V5`](provider/gandi_v5.md)|@TomOnTime|
|[`GCORE`](provider/gcore.md)|@xddxdd|
|[`HEDNS`](provider/hedns.md)|@rblenkinsopp|
|[`HETZNER`](provider/hetzner.md)|@das7pad|
|[`HEXONET`](provider/hexonet.md)|@KaiSchwarz-cnic|
|[`HOSTINGDE`](provider/hostingde.md)|@membero|
|[`HUAWEICLOUD`](provider/huaweicloud.md)|@huihuimoe|
|[`INTERNETBS`](provider/internetbs.md)|@pragmaton|
|[`INWX`](provider/inwx.md)|@patschi|
|[`LINODE`](provider/linode.md)|@koesie10|
|[`LOOPIA`](provider/loopia.md)|@systemcrash|
|[`LUADNS`](provider/luadns.md)|@riku22|
|[`NAMECHEAP`](provider/namecheap.md)|@willpower232|
|[`NETCUP`](provider/netcup.md)|@kordianbruck|
|[`NETLIFY`](provider/netlify.md)|@SphericalKat|
|[`NS1`](provider/ns1.md)|@costasd|
|[`OPENSRS`](provider/opensrs.md)|@philhug|
|[`ORACLE`](provider/oracle.md)|@kallsyms|
|[`OVH`](provider/ovh.md)|@masterzen|
|[`PACKETFRAME`](provider/packetframe.md)|@hamptonmoore|
|[`POWERDNS`](provider/powerdns.md)|@jpbede|
|[`REALTIMEREGISTER`](provider/realtimeregister.md)|@PJEilers|
|[`ROUTE53`](provider/route53.md)|@tresni|
|[`RWTH`](provider/rwth.md)|@MisterErwin|
|[`SAKURACLOUD`](provider/sakuracloud.md)|@ttkzw|
|[`SOFTLAYER`](provider/softlayer.md)|@jamielennox|
|[`TRANSIP`](provider/transip.md)|@blackshadev|
|[`VULTR`](provider/vultr.md)|@pgaskin|
|[`AZURE_PRIVATE_DNS`](azure_private_dns.md)|@matthewmgamble|
|[`AKAMAIEDGEDNS`](akamaiedgedns.md)|@edglynes|
|[`AXFRDDNS`](axfrddns.md)|@hnrgrgr|
|[`BUNNY_DNS`](bunny_dns.md)|@ppmathis|
|[`CLOUDFLAREAPI`](cloudflareapi.md)|@tresni|
|[`CLOUDNS`](cloudns.md)|@pragmaton|
|[`CNR`](cnr.md)|@KaiSchwarz-cnic|
|[`CSCGLOBAL`](cscglobal.md)|@Air-New-Zealand|
|[`DESEC`](desec.md)|@D3luxee|
|[`DIGITALOCEAN`](digitalocean.md)|@Deraen|
|[`DNSIMPLE`](dnsimple.md)|@onlyhavecans|
|[`DNSMADEEASY`](dnsmadeeasy.md)|@vojtad|
|[`DNSOVERHTTPS`](dnsoverhttps.md)|@mikenz|
|[`DOMAINNAMESHOP`](domainnameshop.md)|@SimenBai|
|[`EASYNAME`](easyname.md)|@tresni|
|[`EXOSCALE`](exoscale.md)|@pierre-emmanuelJ|
|[`GANDI_V5`](gandi_v5.md)|@TomOnTime|
|[`GCORE`](gcore.md)|@xddxdd|
|[`HEDNS`](hedns.md)|@rblenkinsopp|
|[`HETZNER`](hetzner.md)|@das7pad|
|[`HEXONET`](hexonet.md)|@KaiSchwarz-cnic|
|[`HOSTINGDE`](hostingde.md)|@membero|
|[`HUAWEICLOUD`](huaweicloud.md)|@huihuimoe|
|[`INTERNETBS`](internetbs.md)|@pragmaton|
|[`INWX`](inwx.md)|@patschi|
|[`LINODE`](linode.md)|@koesie10|
|[`LOOPIA`](loopia.md)|@systemcrash|
|[`LUADNS`](luadns.md)|@riku22|
|[`NAMECHEAP`](namecheap.md)|@willpower232|
|[`NETCUP`](netcup.md)|@kordianbruck|
|[`NETLIFY`](netlify.md)|@SphericalKat|
|[`NS1`](ns1.md)|@costasd|
|[`OPENSRS`](opensrs.md)|@philhug|
|[`ORACLE`](oracle.md)|@kallsyms|
|[`OVH`](ovh.md)|@masterzen|
|[`PACKETFRAME`](packetframe.md)|@hamptonmoore|
|[`POWERDNS`](powerdns.md)|@jpbede|
|[`REALTIMEREGISTER`](realtimeregister.md)|@PJEilers|
|[`ROUTE53`](route53.md)|@tresni|
|[`RWTH`](rwth.md)|@MisterErwin|
|[`SAKURACLOUD`](sakuracloud.md)|@ttkzw|
|[`SOFTLAYER`](softlayer.md)|@jamielennox|
|[`TRANSIP`](transip.md)|@blackshadev|
|[`VULTR`](vultr.md)|@pgaskin|

### Requested providers

Expand All @@ -181,7 +181,7 @@ code to support this provider, we'd be glad to help in any way.

#### Q: Why are the above GitHub issues marked "closed"?

A: Following [the bug triage process](bug-triage.md), the request
A: Following [the bug triage process](../bug-triage.md), the request
is closed once it is added to this list. If someone chooses to implement the
provider, they re-open the issue.

Expand Down
2 changes: 1 addition & 1 deletion documentation/provider/route53.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ D("testzone.net!public", REG_NONE,
{% endcode %}

## Activation
DNSControl depends on a standard [AWS access key](https://aws.amazon.com/developers/access-keys/) with permission to list, create and update hosted zones. If you do not have the permissions required you will receive the following error message `Check your credentials, your not authorized to perform actions on Route 53 AWS Service`.
DNSControl depends on a standard [AWS access key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) with permission to list, create and update hosted zones. If you do not have the permissions required you will receive the following error message `Check your credentials, your not authorized to perform actions on Route 53 AWS Service`.

You can apply the `AmazonRoute53FullAccess` policy however this includes access to many other areas of AWS. The minimum permissions required are as follows:

Expand Down

0 comments on commit e0e32ca

Please sign in to comment.