Skip to content

Commit e0185b4

Browse files
[SSL] Replace nav steps with DashButton or deep links (#26109)
* First batch of changes * Second batch: always-use-https has some good contextual edits * Final batch, still without partials * Fix missing DashButton component import * Re-add GlossaryTooltip to origin-ca/index.mdx * Manual adjustments: inherited inconsistencies * Manual adjustments: use DashButton first in always-use-https * Apply batched changes to SSL partials * Replace cases where steps refer other product areas * Manual adjustment: Fix usage of non-existent route * Apply suggestions from code review Co-authored-by: Pedro Sousa <[email protected]> * Address comments from PCX review --------- Co-authored-by: Pedro Sousa <[email protected]>
1 parent f0716cd commit e0185b4

39 files changed

+260
-193
lines changed

src/content/docs/ssl/client-certificates/byo-ca.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: Cloudflare mTLS now supports client certificates that have not been
99
Cloudflare mTLS.
1010
---
1111

12-
import { Render, APIRequest, Tabs, TabItem } from "~/components";
12+
import { APIRequest, Render, TabItem, Tabs, DashButton } from "~/components";
1313

1414
This page explains how you can manage client certificates that have not been issued by Cloudflare CA. For a broader overview, refer to the [mTLS at Cloudflare learning path](/learning-paths/mtls/concepts/).
1515

@@ -85,11 +85,13 @@ If you wish to remove the association from the Cloudflare-managed certificate an
8585

8686
<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
8787

88-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account and domain.
89-
2. Go to **SSL/TLS** > **Client Certificates**.
90-
3. On the **Hosts** section of the **Client Certificates** card, select **Edit**.
91-
4. Select the cross next to the hostname you want to remove. The list of hostname associations will be updated.
92-
5. Select **Save** to confirm.
88+
1. In the Cloudflare dashboard, go to the **Client Certificates** page.
89+
90+
<DashButton url="/?to=/:account/:zone/ssl-tls/client-certificates" />
91+
92+
2. On the **Hosts** section of the **Client Certificates** card, select **Edit**.
93+
3. Select the cross next to the hostname you want to remove. The list of hostname associations will be updated.
94+
4. Select **Save** to confirm.
9395

9496
</TabItem> <TabItem label="API">
9597

src/content/docs/ssl/client-certificates/create-a-client-certificate.mdx

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ sidebar:
66

77
---
88

9-
import { Details } from "~/components";
9+
import { Details, DashButton } from "~/components";
1010

1111
To create a client certificate on the Cloudflare dashboard:
1212

13-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account and zone/domain.
14-
2. Go to **SSL/TLS** > **Client Certificates**.
15-
3. Select **Create Certificate** and fill in the required fields. You can choose one of the following options:
13+
1. In the Cloudflare dashboard, go to the **Client Certificates** page.
14+
15+
<DashButton url="/?to=/:account/:zone/ssl-tls/client-certificates" />
16+
17+
2. Select **Create Certificate** and fill in the required fields. You can choose one of the following options:
1618

1719
- Generate a private key and Certificate Signing Request (CSR) with Cloudflare.
1820
- Use your own private key and CSR. This option allows you to also [label client certificates](/ssl/client-certificates/label-client-certificate/).
@@ -31,9 +33,9 @@ To create a client certificate on the Cloudflare dashboard:
3133
Client certificates created on the dashboard are issued by a [Cloudflare-managed CA](/ssl/client-certificates/#how-it-works). If you need to use certificates issued by another CA, use the API to [bring your own CA](/ssl/client-certificates/byo-ca/) instead.
3234
:::
3335

34-
4. Select a value for **Certificate Validity**, and choose **Create**.
35-
5. Make sure to copy the certificate and private key as they will no longer be displayed after creation.
36-
6. Select **OK** to confirm.
36+
3. Select a value for **Certificate Validity**, and choose **Create**.
37+
4. Make sure to copy the certificate and private key as they will no longer be displayed after creation.
38+
5. Select **OK** to confirm.
3739

3840
## Next steps
3941

src/content/docs/ssl/client-certificates/enable-mtls.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,22 @@ sidebar:
66

77
---
88

9-
import { Render } from "~/components"
9+
import { Render, DashButton } from "~/components"
1010

1111
You can enable mutual Transport Layer Security (mTLS) for any hostname.
1212

1313
To enable mTLS for a host from the Cloudflare dashboard:
1414

15-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account and domain.
16-
2. Go to **SSL/TLS** > **Client Certificates**.
17-
3. On the **Hosts** section of the **Client Certificates** card, select **Edit**.
18-
4. Enter the name of a host in your current domain.
15+
1. In the Cloudflare dashboard, go to the **Client Certificates** page.
16+
17+
<DashButton url="/?to=/:account/:zone/ssl-tls/client-certificates" />
18+
19+
2. On the **Hosts** section of the **Client Certificates** card, select **Edit**.
20+
3. Enter the name of a host in your current domain.
1921
:::note
2022
The domain (`example.com`) is automatically appended for you. This means that, if you want to enable mTLS for `abc.example.com`, you only need to type `abc`.
2123
:::
22-
5. Select **Save** to confirm.
24+
4. Select **Save** to confirm.
2325

2426
## CAs in use
2527

src/content/docs/ssl/client-certificates/revoke-client-certificate.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,20 @@ sidebar:
66

77
---
88

9+
import { DashButton } from "~/components";
10+
911
You can revoke a client certificate you previously generated with the default [Cloudflare Managed CA](/ssl/client-certificates/).
1012

11-
It is not possible to permanently delete client certificates generated with the default Cloudflare Managed CA. Once revoked, these client certificates will still be listed in **SSL/TLS > Client Certificates**, and can be restored at any time.
13+
It is not possible to permanently delete client certificates generated with the default Cloudflare Managed CA. Once revoked, these client certificates will still be listed on the [**Client Certificates**](https://dash.cloudflare.com/?to=/:account/:zone/ssl-tls/client-certificates) page, and can be restored at any time.
1214

1315
## Steps
1416

15-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account and application.
16-
2. Go to **SSL** > **Client Certificates**.
17-
3. Select the certificate you want to revoke.
18-
4. Select **Revoke** and confirm the operation.
17+
1. In the Cloudflare dashboard, go to the **Client Certificates** page.
18+
19+
<DashButton url="/?to=/:account/:zone/ssl-tls/client-certificates" />
20+
21+
2. Select the certificate you want to revoke.
22+
3. Select **Revoke** and confirm the operation.
1923

2024
:::caution[Important]
2125

src/content/docs/ssl/client-certificates/troubleshooting.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ head:
99
content: Troubleshooting client certificates
1010
---
1111

12+
import { DashButton } from "~/components";
13+
1214
If your query returns an error even after configuring and embedding a client SSL certificate, check the following settings.
1315

1416
---
@@ -33,9 +35,11 @@ Check whether [mTLS has been enabled](/ssl/client-certificates/enable-mtls/) for
3335

3436
## Review mTLS rules
3537

36-
To review mTLS rules:
38+
To review mTLS rules, consider the steps below. For further guidance refer to [Custom rules](/waf/custom-rules/create-dashboard/).
39+
40+
1. In the Cloudflare dashboard, go to the **Security rules** page.
3741

38-
1. Select **Security** > **WAF** > **Custom rules**.
42+
<DashButton url="/?to=/:account/:zone/security/security-rules" />
3943

4044
2. On a specific rule, select **Edit**.
4145

@@ -48,4 +52,4 @@ To review mTLS rules:
4852
(http.host in {"api.trackers.ninja"} and not cf.tls_client_auth.cert_verified)
4953
```
5054

51-
4. To edit the rule, either use the user interface or select **Edit expression**.
55+
4. To edit the rule, either use the user interface or select **Edit expression**.

src/content/docs/ssl/edge-certificates/additional-options/always-use-https.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar:
88
order: 15
99
---
1010

11-
import { FeatureTable, TabItem, Tabs } from "~/components";
11+
import { FeatureTable, TabItem, Tabs, DashButton } from "~/components";
1212

1313
Always Use HTTPS redirects all your visitor requests from `http` to `https`, for all subdomains and hosts in your application.
1414

@@ -36,10 +36,13 @@ If only some parts of your application can support HTTPS traffic, do not enable
3636

3737
To enable **Always Use HTTPS** in the dashboard:
3838

39-
1. Log in to your [Cloudflare account](https://dash.cloudflare.com) and go to a specific domain.
40-
2. In **SSL/TLS** > **Overview**, make sure that your [SSL/TLS encryption mode](/ssl/origin-configuration/ssl-modes/off/) **is not** set to **Off**. When you set your encryption mode to **Off**, the **Always Use HTTPS** option will not be visible in your Cloudflare dashboard.
41-
3. Go to **SSL/TLS** > **Edge Certificates**.
42-
4. For **Always Use HTTPS**, switch the toggle to **On**.
39+
1. In the Cloudflare dashboard, go to the **SSL/TLS Overview** page.
40+
41+
<DashButton url="/?to=/:account/:zone/ssl-tls" />
42+
43+
2. Make sure that your [SSL/TLS encryption mode](/ssl/origin-configuration/ssl-modes/off/) is not set to **Off**. When you set your encryption mode to **Off**, the **Always Use HTTPS** option will not be visible in your Cloudflare dashboard.
44+
3. Go to the [**Edge Certificates**](https://dash.cloudflare.com/?to=/:account/:zone/ssl-tls/edge-certificates) page.
45+
4. Turn on **Always Use HTTPS**.
4346

4447
</TabItem> <TabItem label="API">
4548

src/content/docs/ssl/edge-certificates/additional-options/automatic-https-rewrites.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar:
55
order: 14
66
---
77

8-
import { FeatureTable, Render, TabItem, Tabs } from "~/components";
8+
import { FeatureTable, Render, TabItem, Tabs, DashButton } from "~/components";
99

1010
Automatic HTTPS Rewrites prevents end users from seeing "mixed content" errors by rewriting URLs from `http` to `https` for resources or links on your web site that can be served with HTTPS.
1111

@@ -31,9 +31,11 @@ For security reasons, this feature will run on URLs pointing to `localhost` if t
3131

3232
To enable **Automatic HTTPS Rewrites** in the dashboard:
3333

34-
1. Log in to your [Cloudflare account](https://dash.cloudflare.com) and go to a specific domain.
35-
2. Go to **SSL/TLS** > **Edge Certificates**.
36-
3. For **Automatic HTTPS Rewrites**, switch the toggle to **On**.
34+
1. In the Cloudflare dashboard, go to the **Edge Certificates** page.
35+
36+
<DashButton url="/?to=/:account/:zone/ssl-tls/edge-certificates" />
37+
38+
2. For **Automatic HTTPS Rewrites**, switch the toggle to **On**.
3739

3840
</TabItem> <TabItem label="API">
3941

src/content/docs/ssl/edge-certificates/additional-options/certificate-signing-requests.mdx

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar:
55
order: 11
66
---
77

8-
import { FeatureTable, Render } from "~/components";
8+
import { FeatureTable, Render, DashButton } from "~/components";
99

1010
<Render file="csr-definition" product="ssl" />
1111

@@ -24,19 +24,20 @@ You can create two types of CSRs:
2424

2525
To create a CSR:
2626

27-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account and an application.
28-
2. Go to **SSL/TLS** > **Edge Certificates**.
29-
3. On **Certificate Signing Request (CSR)**, select **Generate**.
30-
4. Choose a **Scope** (only [certain customers](#types-of-csrs) can choose **Account**).
31-
5. Enter relevant information on the form and select **Create**.
27+
1. In the Cloudflare dashboard, go to the **Edge Certificates** page.
28+
29+
<DashButton url="/?to=/:account/:zone/ssl-tls/edge-certificates" />
30+
31+
2. On **Certificate Signing Request (CSR)**, select **Generate**.
32+
3. Choose a **Scope** (only [certain customers](#types-of-csrs) can choose **Account**).
33+
4. Enter relevant information on the form and select **Create**.
3234

3335
To use a CSR:
3436

35-
1. Go to **SSL/TLS** > **Edge Certificates**.
36-
2. On **Certificate Signing Request (CSR)**, select the record you just created.
37-
3. Copy (or select **Click to copy**) the value for **Certificate Signing Request**.
38-
4. Obtain a certificate from the Certificate Authority (CA) of your choice using your CSR.
39-
5. When you [upload the custom certificate](/ssl/edge-certificates/custom-certificates/uploading/) to Cloudflare, select an **Encoding mode** of **Certificate Signing Request (CSR)** and enter the associated value.
37+
1. On the [**Edge Certificates**](https://dash.cloudflare.com/?to=/:account/:zone/ssl-tls/edge-certificates) page, select the CSR record you just created under **Certificate Signing Request (CSR)**.
38+
2. Copy (or select **Click to copy**) the value for **Certificate Signing Request**.
39+
3. Obtain a certificate from the Certificate Authority (CA) of your choice using your CSR.
40+
4. When you [upload the custom certificate](/ssl/edge-certificates/custom-certificates/uploading/) to Cloudflare, select an **Encoding mode** of **Certificate Signing Request (CSR)** and enter the associated value.
4041

4142
:::note
4243
You will not see the option to adjust your **Encoding Mode** until after you have created a CSR associated with the specific zone or your account.

src/content/docs/ssl/edge-certificates/additional-options/certificate-transparency-monitoring.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ CT Monitoring alerts are triggered not only by Cloudflare processes - including
3636

3737
## Opt in and out
3838

39-
Alerts are turned off by default. If you want to receive alerts, go to [**SSL/TLS** > **Edge Certificates**](https://dash.cloudflare.com/?to=/:account/:zone/ssl-tls/edge-certificates#ct-alerting-card) and enable **Certificate Transparency Monitoring**. If you are in a Business or Enterprise zone, select **Add Email**.
39+
Alerts are turned off by default. If you want to receive alerts, go to the [**Edge Certificates**](https://dash.cloudflare.com/?to=/:account/:zone/ssl-tls/edge-certificates#ct-alerting-card) page and enable **Certificate Transparency Monitoring**. If you are in a Business or Enterprise zone, select **Add Email**.
4040

4141
To stop receiving alerts, disable **Certificate Transparency Monitoring** or remove your email from the feature card.
4242

src/content/docs/ssl/edge-certificates/additional-options/cipher-suites/customize-cipher-suites/api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Note that:
2222
- Updating the cipher suites will result in certificates being redeployed.
2323
- Cipher suites are used in combination with other [SSL/TLS settings](/ssl/edge-certificates/additional-options/cipher-suites/#related-ssltls-settings).
2424
- You cannot set specific TLS 1.3 ciphers. Instead, you can [enable TLS 1.3](/ssl/edge-certificates/additional-options/tls-13/#enable-tls-13) for your entire zone and Cloudflare will use all applicable [TLS 1.3 cipher suites](/ssl/edge-certificates/additional-options/cipher-suites/supported-cipher-suites/).
25-
- Each cipher suite also supports a specific algorithm (RSA or ECDSA) so you should consider the algorithms in use by your edge certificates when making your ciphers selection. You can find this information under each certificate listed in [**SSL/TLS** > **Edge Certificates**](https://dash.cloudflare.com/?to=/:account/:zone/ssl-tls/edge-certificates).
25+
- Each cipher suite also supports a specific algorithm (RSA or ECDSA) so you should consider the algorithms in use by your edge certificates when making your ciphers selection. You can find this information under each certificate listed on the [**Edge Certificates**](https://dash.cloudflare.com/?to=/:account/:zone/ssl-tls/edge-certificates) page.
2626
- It is not possible to configure minimum TLS version nor cipher suites for [Cloudflare Pages](/pages/) hostnames.
2727
- If you use Windows you might need to adjust the `curl` syntax, refer to [Making API calls on Windows](/fundamentals/api/how-to/make-api-calls/#making-api-calls-on-windows) for further guidance.
2828

0 commit comments

Comments
 (0)