Skip to content

Commit 5941a14

Browse files
[DNS] Improve 'DNS setup' and monospace usage (#19168)
* Audit and replace 'zone setup' by 'DNS setup' as applicable * Audit and remove excessive monospacing * Apply suggestion from code review Co-authored-by: Pedro Sousa <[email protected]> * Address remaining monospace in dnssec.mdx --------- Co-authored-by: Pedro Sousa <[email protected]>
1 parent bd9d4aa commit 5941a14

File tree

26 files changed

+97
-97
lines changed

26 files changed

+97
-97
lines changed

src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/saas-customers/provider-guides/salesforce-commerce-cloud.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ To enable O2O requires the following:
3232
1. Your SFCC environment must be configured as an "SFCC Proxy Zone". If you currently have an "SFCC Legacy Zone", you cannot enable O2O. More details on the different types of SFCC configurations can be found in the [Salesforce FAQ on SFCC Proxy Zones](https://help.salesforce.com/s/articleView?id=cc.b2c_ecdn_proxy_zone_faq.htm&type=5).
3333
2. Your own Cloudflare zone on an Enterprise plan.
3434

35-
If you meet the above requirements, O2O can then be enabled per hostname. To enable O2O for a specific hostname within your Cloudflare zone, [create](/dns/manage-dns-records/how-to/create-dns-records/#create-dns-records) a Proxied `CNAME` DNS record with a target of the `CNAME` provided by SFCC Business Manager, which is the dashboard used by SFCC customers to configure their storefront environment.
35+
If you meet the above requirements, O2O can then be enabled per hostname. To enable O2O for a specific hostname within your Cloudflare zone, [create](/dns/manage-dns-records/how-to/create-dns-records/#create-dns-records) a Proxied CNAME DNS record with a target of the CNAME provided by SFCC Business Manager, which is the dashboard used by SFCC customers to configure their storefront environment.
3636

37-
The `CNAME` provided by SFCC Business Manager will resemble `commcloud.prod-abcd-example-com.cc-ecdn.net` and contains 3 distinct parts. For each hostname routing traffic to SFCC, be sure to update each part of the example `CNAME` to match your SFCC environment:
37+
The CNAME provided by SFCC Business Manager will resemble `commcloud.prod-abcd-example-com.cc-ecdn.net` and contains 3 distinct parts. For each hostname routing traffic to SFCC, be sure to update each part of the example CNAME to match your SFCC environment:
3838

3939
1. **Environment**: `prod` should be changed to `prod` or `dev` or `stg`.
4040
2. **Realm**: `abcd` should be changed to the Realm ID assigned to you by SFCC.

src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/troubleshooting.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,24 @@ If a domain is flagged by the CA, you need to contact Support before validation
1919

2020
## Certificate Authority Authorization (CAA) records
2121

22-
`CAA` is a DNS resource record type defined in [RFC 6844](https://datatracker.ietf.org/doc/html/rfc6844) that allows a domain owner to indicate which CAs are allowed to issue certificates for them.
22+
CAA is a DNS resource record type defined in [RFC 6844](https://datatracker.ietf.org/doc/html/rfc6844) that allows a domain owner to indicate which CAs are allowed to issue certificates for them.
2323

2424
### For SaaS providers
2525

26-
If your customer has `CAA` records set on their domain, they will either need to add the following or remove `CAA` entirely:
26+
If your customer has CAA records set on their domain, they will either need to add the following or remove CAA entirely:
2727

2828
```txt
2929
example.com. IN CAA 0 issue "letsencrypt.org"
3030
example.com. IN CAA 0 issue "pki.goog"
3131
```
3232

33-
While it is possible for `CAA` records to be set on the subdomain your customer wishes to use with your service, it will usually be set on the domain apex. If they have `CAA` records on the subdomain, those will also have to be removed.
33+
While it is possible for CAA records to be set on the subdomain your customer wishes to use with your service, it will usually be set on the domain apex. If they have CAA records on the subdomain, those will also have to be removed.
3434

3535
### For SaaS customers
3636

37-
In some cases, the validation may be prevented because your hostname points to a `CNAME` target where `CAA` records are defined.
37+
In some cases, the validation may be prevented because your hostname points to a CNAME target where CAA records are defined.
3838

39-
In this case you would need to either select a Certificate Authority whose `CAA` records are present at the target, or review the configuration with the service provider that owns the target.
39+
In this case you would need to either select a Certificate Authority whose CAA records are present at the target, or review the configuration with the service provider that owns the target.
4040

4141
***
4242

src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/start/advanced-settings/apex-proxying/setup.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,35 +49,35 @@ These IP addresses are different than those associated with your Cloudflare zone
4949

5050
### 3. Have customer create DNS record
5151

52-
To finish the custom hostname setup, your customer can set up either an `A` or `CNAME` record at their authoritative DNS provider.
52+
To finish the custom hostname setup, your customer can set up either an A or CNAME record at their authoritative DNS provider.
5353

5454
:::note
5555

5656

57-
If you want your customers to be able to use `CNAME` records, you will need to complete the [normal setup process](/cloudflare-for-platforms/cloudflare-for-saas/start/getting-started/) as well.
57+
If you want your customers to be able to use CNAME records, you will need to complete the [normal setup process](/cloudflare-for-platforms/cloudflare-for-saas/start/getting-started/) as well.
5858

5959

6060
:::
6161

62-
#### `A` record
62+
#### A record
6363

64-
If your customer uses an `A` record at their authoritative DNS provider, they need to point their hostname to the IP prefixed allocated for your account.
64+
If your customer uses an A record at their authoritative DNS provider, they need to point their hostname to the IP prefixed allocated for your account.
6565

6666
<Render file="get-started-check-statuses" />
6767

68-
Your customer's `A` record might look like the following:
68+
Your customer's A record might look like the following:
6969

7070
```txt
7171
example.com. 60 IN A 192.0.2.1
7272
```
7373

74-
#### `CNAME` record
74+
#### CNAME record
7575

76-
If your customer uses a `CNAME` record at their authoritative DNS, they need to point their hostname to your [`CNAME` target](/cloudflare-for-platforms/cloudflare-for-saas/start/getting-started/#2-optional-create-cname-target) [^1].
76+
If your customer uses a CNAME record at their authoritative DNS, they need to point their hostname to your [CNAME target](/cloudflare-for-platforms/cloudflare-for-saas/start/getting-started/#2-optional-create-cname-target) [^1].
7777

7878
<Render file="get-started-check-statuses" />
7979

80-
Your customer's `CNAME` record might look like the following:
80+
Your customer's CNAME record might look like the following:
8181

8282
```txt
8383
mystore.com CNAME customers.saasprovider.com

src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/start/getting-started.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ import { Example, Render } from "~/components"
2626

2727
### 2. (Optional) Create CNAME target
2828

29-
The `CNAME` target — optional, but highly encouraged — provides a friendly and more flexible place for customers to [route their traffic](#3-have-customer-create-cname-record). You may want to use a subdomain such as `customers.<SAAS_PROVIDER>.com`.
29+
The CNAME target — optional, but highly encouraged — provides a friendly and more flexible place for customers to [route their traffic](#3-have-customer-create-cname-record). You may want to use a subdomain such as `customers.<SAAS_PROVIDER>.com`.
3030

31-
[Create](/dns/manage-dns-records/how-to/create-dns-records/#create-dns-records) a proxied `CNAME` that points your `CNAME` target to your fallback origin (can be a wildcard such as `*.customers.saasprovider.com`).
31+
[Create](/dns/manage-dns-records/how-to/create-dns-records/#create-dns-records) a proxied CNAME that points your CNAME target to your fallback origin (can be a wildcard such as `*.customers.saasprovider.com`).
3232

3333
<Example>
3434

@@ -46,11 +46,11 @@ The `CNAME` target — optional, but highly encouraged — provides a friendly a
4646

4747
### 3. Have customer create CNAME record
4848

49-
To finish the custom hostname setup, your customer needs to set up a `CNAME` record at their authoritative DNS that points to your [`CNAME` target](#2-optional-create-cname-target) [^1].
49+
To finish the custom hostname setup, your customer needs to set up a CNAME record at their authoritative DNS that points to your [CNAME target](#2-optional-create-cname-target) [^1].
5050

5151
<Render file="get-started-check-statuses" />
5252

53-
Your customer's `CNAME` record might look like the following:
53+
Your customer's CNAME record might look like the following:
5454

5555
```txt
5656
mystore.example.com CNAME customers.saasprovider.com
@@ -67,7 +67,7 @@ B --> C[<code>proxy-fallback.saasprovider.com</code>]
6767

6868
<br/>
6969

70-
Requests to `mystore.example.com` would go to your `CNAME` target (`customers.saasprovider.com`), which would then route to your fallback origin (`proxy-fallback.saasprovider.com`).
70+
Requests to `mystore.example.com` would go to your CNAME target (`customers.saasprovider.com`), which would then route to your fallback origin (`proxy-fallback.saasprovider.com`).
7171

7272
[^1]: <Render file="regional-services" />
7373

src/content/docs/dns/cname-flattening/cname-flattening-diagram.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,20 @@ description: Consider an example use case and the main steps involved in CNAME f
1212

1313
import { Example } from "~/components"
1414

15-
With `CNAME` flattening, Cloudflare returns an IP address instead of the target hostname that a `CNAME` record points to.
15+
With CNAME flattening, Cloudflare returns an IP address instead of the target hostname that a CNAME record points to.
1616
This process supports a few features and delivers better performance and flexibility, as mentioned in the [CNAME flattening concept page](/dns/cname-flattening/).
1717

18-
Consider the diagram below to have an overview of the steps that may be involved in `CNAME` flattening.
18+
Consider the diagram below to have an overview of the steps that may be involved in CNAME flattening.
1919

2020
:::note
2121

22-
Note that this is a simpler scenario. Cases where `CNAME` flattening is optional and/or the target hostname is not external to Cloudflare work differently.
22+
Note that this is a simpler scenario. Cases where CNAME flattening is optional and/or the target hostname is not external to Cloudflare work differently.
2323

2424
:::
2525

2626
## Example use case
2727

28-
* `domain.test` is a zone on Cloudflare and has the following `CNAME` record:
28+
* `domain.test` is a zone on Cloudflare and has the following CNAME record:
2929

3030
<Example>
3131

@@ -83,5 +83,5 @@ accDescr: Diagram of CNAME flattening process when there is a request for a doma
8383

8484
## Aspects to consider
8585

86-
* If the `CNAME` record is proxied in Cloudflare, the answer is made up of multiple [Cloudflare IPs](https://www.cloudflare.com/ips/) and its Time to Live (TTL) is set to `300`.
87-
* If the `CNAME` record in Cloudflare is not proxied, the flattened answer consists of the IP address from the external DNS provider and its TTL corresponds to the lower value between the external record and the Cloudflare `CNAME` record.
86+
* If the CNAME record is proxied in Cloudflare, the answer is made up of multiple [Cloudflare IPs](https://www.cloudflare.com/ips/) and its Time to Live (TTL) is set to `300`.
87+
* If the CNAME record in Cloudflare is not proxied, the flattened answer consists of the IP address from the external DNS provider and its TTL corresponds to the lower value between the external record and the Cloudflare CNAME record.

src/content/docs/dns/cname-flattening/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar:
88

99
import { Render } from "~/components"
1010

11-
`CNAME` flattening speeds up `CNAME` resolution and allows you to use a `CNAME` record at your root/apex domain (`example.com`).
11+
CNAME flattening speeds up CNAME resolution and allows you to use a CNAME record at your root/apex domain (`example.com`).
1212

1313
:::note
1414

@@ -20,11 +20,11 @@ This functionality is also what allows you to use a [root custom domain](/pages/
2020

2121
## How it works
2222

23-
With `CNAME` flattening, Cloudflare finds the IP address that a `CNAME` points to. This process could involve a single lookup or multiple (if your `CNAME` points to another `CNAME`). Cloudflare then returns the final IP address instead of a `CNAME` record, helping DNS queries resolve up to 30% faster.
23+
With CNAME flattening, Cloudflare finds the IP address that a CNAME points to. This process could involve a single lookup or multiple (if your CNAME points to another CNAME). Cloudflare then returns the final IP address instead of a CNAME record, helping DNS queries resolve up to 30% faster.
2424

25-
For more details on the steps involved in `CNAME` flattening, review the [CNAME flattening diagram](/dns/cname-flattening/cname-flattening-diagram/) and refer to the [Cloudflare blog post](https://blog.cloudflare.com/introducing-cname-flattening-rfc-compliant-cnames-at-a-domains-root/).
25+
For more details on the steps involved in CNAME flattening, review the [CNAME flattening diagram](/dns/cname-flattening/cname-flattening-diagram/) and refer to the [Cloudflare blog post](https://blog.cloudflare.com/introducing-cname-flattening-rfc-compliant-cnames-at-a-domains-root/).
2626

2727
## Aspects to keep in mind
2828

29-
* `CNAME` flattening happens by default in some cases. Refer to [Setup](/dns/cname-flattening/set-up-cname-flattening/) for details.
29+
* CNAME flattening happens by default in some cases. Refer to [Setup](/dns/cname-flattening/set-up-cname-flattening/) for details.
3030
* <Render file="cname-flattening-callout" />

src/content/docs/dns/cname-flattening/set-up-cname-flattening.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@ import { Render, TabItem, Tabs, GlossaryTooltip } from "~/components"
1414
:::note
1515

1616

17-
If the `CNAME` target is on the same zone as the `CNAME` record, Cloudflare proceeds with `CNAME` flattening and ignores the **CNAME Flattening** setting.
17+
If the CNAME target is on the same zone as the CNAME record, Cloudflare proceeds with CNAME flattening and ignores the **CNAME Flattening** setting.
1818

1919

2020
:::
2121

2222
## For your zone apex
2323

24-
`CNAME` flattening occurs by default for all plans when your domain uses a `CNAME` record for its zone apex (`example.com`, meaning the record **Name** is set to `@`).
24+
CNAME flattening occurs by default for all plans when your domain uses a CNAME record for its zone apex (`example.com`, meaning the record **Name** is set to `@`).
2525

2626
## For all CNAME records
2727

28-
For zones on paid plans, you can choose to flatten all `CNAME` records. This option is useful for <GlossaryTooltip term="proxy status">DNS-only (unproxied)</GlossaryTooltip> `CNAME` records. [Proxied records](/dns/manage-dns-records/reference/proxied-dns-records/#proxied-records) are flattened by default as they return Cloudflare anycast IPs.
28+
For zones on paid plans, you can choose to flatten all CNAME records. This option is useful for <GlossaryTooltip term="proxy status">DNS-only (unproxied)</GlossaryTooltip> CNAME records. [Proxied records](/dns/manage-dns-records/reference/proxied-dns-records/#proxied-records) are flattened by default as they return Cloudflare anycast IPs.
2929

3030
<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
3131

@@ -45,15 +45,15 @@ Make a `PATCH` request to the [Update DNS Settings](/api/resources/dns/subresour
4545

4646
## Per record
4747

48-
Paid zones also have the option of flattening specific `CNAME` records.
48+
Paid zones also have the option of flattening specific CNAME records.
4949

50-
If you use this option, a special [tag](/dns/manage-dns-records/reference/record-attributes/) `cf-flatten-cname` will be added to the respective flattened `CNAME` records in your zone file, allowing you to [export and import records](/dns/manage-dns-records/how-to/import-and-export/) without losing this configuration.
50+
If you use this option, a special [tag](/dns/manage-dns-records/reference/record-attributes/) `cf-flatten-cname` will be added to the respective flattened CNAME records in your zone file, allowing you to [export and import records](/dns/manage-dns-records/how-to/import-and-export/) without losing this configuration.
5151

5252
<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
5353

5454
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account and domain.
5555
2. In **DNS** > **Settings**, make sure that **CNAME flattening for all CNAME records** is turned off.
56-
3. Go to **DNS** > **Records** and find the `CNAME` record you would like to flatten.
56+
3. Go to **DNS** > **Records** and find the CNAME record you would like to flatten.
5757
4. Select **Edit** and turn on the **Flatten** option.
5858
5. Select **Save** to confirm.
5959

@@ -66,7 +66,7 @@ For the following cases, **Flatten** will not be available:
6666

6767
</TabItem> <TabItem label="API">
6868

69-
With the available [API endpoints](/api/resources/dns/subresources/records/methods/create/), specify the following for each `CNAME` record in the request body:
69+
With the available [API endpoints](/api/resources/dns/subresources/records/methods/create/), specify the following for each CNAME record in the request body:
7070

7171
```txt
7272
"settings": {

src/content/docs/dns/dns-firewall/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { Description, Plan } from "~/components"
1010

1111
<Description>
1212

13-
Speed up and protect entire authoritative nameservers
13+
Speed up and protect entire authoritative nameservers
1414
</Description>
1515

1616
<Plan type="ent-add-on" />
@@ -19,7 +19,7 @@ Cloudflare DNS Firewall proxies all DNS queries to your nameservers through Clou
1919

2020
![Diagram showing protection provided by DNS Firewall. For more details, read further.](~/assets/images/dns/dns-firewall-overview.png)
2121

22-
DNS Firewall is for customers who need to speed up and protect entire authoritative nameservers. If you need to speed up and protect individual zones, see Cloudflare DNS [Zone Setups](/dns/zone-setups).
22+
DNS Firewall is for customers who need to speed up and protect entire authoritative nameservers. If you need to speed up and protect individual zones, refer to Cloudflare DNS [Setups](/dns/zone-setups/).
2323

2424
***
2525

src/content/docs/dns/dnssec/dnssec-states.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ This page describes different DNSSEC states and how they relate to the responses
1818

1919
:::caution
2020

21-
Once you have enabled DNSSEC on a zone for the first time, you cannot transition directly from an `active` state to a `deleted` state. You can only [delete DNSSEC records](/api/resources/dns/subresources/dnssec/methods/delete/) once your zone DNSSEC is in a `disabled` state. Cloudflare prevents you from deleting DNSSEC records before removing the DS record from the registrar to avoid DNS resolution issues.
21+
Once you have enabled DNSSEC on a zone for the first time, you cannot transition directly from an `active` state to a `deleted` state. You can only [delete DNSSEC records](/api/resources/dns/subresources/dnssec/methods/delete/) once your zone DNSSEC is in a `disabled` state. Cloudflare prevents you from deleting DNSSEC records before removing the DS record from the registrar to avoid DNS resolution issues.
2222
:::
2323

24-
In both `pending` and `active` states, Cloudflare signs the zone and responds with `RRSIG`, `NSEC`, `DNSKEY`, `CDS`, and `CDNSKEY` record types.
24+
In both `pending` and `active` states, Cloudflare signs the zone and responds with RRSIG, NSEC, DNSKEY, CDS, and CDNSKEY record types.
2525

26-
In `pending-disabled` and `disabled` states, Cloudflare still signs the zone and serves `RRSIG`, `NSEC`, and `DNSKEY` record types, but the `CDS` and `CDNSKEY` records are set to zero ([RFC 8078](https://www.rfc-editor.org/rfc/rfc8078.html#section-4)), signaling to the registrar that DNSSEC should be disabled.
26+
In `pending-disabled` and `disabled` states, Cloudflare still signs the zone and serves RRSIG, NSEC, and DNSKEY record types, but the CDS and CDNSKEY records are set to zero ([RFC 8078](https://www.rfc-editor.org/rfc/rfc8078.html#section-4)), signaling to the registrar that DNSSEC should be disabled.
2727

28-
In `deleted` state, Cloudflare does **not** sign the zone and does **not** respond with `RRSIG`, `NSEC`, `DNSKEY`, `CDS`, and `CDNSKEY` record types.
28+
In `deleted` state, Cloudflare does **not** sign the zone and does **not** respond with RRSIG, NSEC, DNSKEY, CDS, and CDNSKEY record types.
2929

3030
Refer to [How DNSSEC works](https://www.cloudflare.com/dns/dnssec/how-dnssec-works/) to learn more about the authentication process and records involved.

0 commit comments

Comments
 (0)