Skip to content

Commit d5a484b

Browse files
Oxyjunpedrosousa
andauthored
[Jun] Updating dashboard instructions with DashButton. (#24861)
* Updating instructions for Workers KV dashboard instructions * Updating dashbutton for all affected D1 chapters * Updating Hyperdrive chapters with DashButton * Updating R2 chapters dashboard instructions * Catching missed R2 chapters * Catching DO docs * Updating dash instructions for Pages docs * Pushing changes for Workers AI docs * Adding introductory sentence when using the DashButton * Apply suggestions from code review Co-authored-by: Pedro Sousa <[email protected]> * Adding button for Workers KV --------- Co-authored-by: Pedro Sousa <[email protected]>
1 parent cb0ecd5 commit d5a484b

File tree

78 files changed

+731
-810
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+731
-810
lines changed

src/content/docs/cloudflare-one/policies/access/external-evaluation.mdx

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

8-
import { GlossaryTooltip, Example, WranglerConfig } from "~/components";
8+
import { GlossaryTooltip, Example, WranglerConfig, DashButton } from "~/components";
99

1010
With Cloudflare Access, you can create Allow or Block policies which evaluate the user based on custom criteria. This is done by adding an **External Evaluation** rule to your policy. The **External Evaluation** selector requires two values:
1111

@@ -102,7 +102,8 @@ To generate an RSA private/public key pair:
102102
1. Open a browser and go to `https://my-worker.<YOUR_SUBDOMAIN>.workers.dev/keys`.
103103

104104
2. (Optional) Verify that the key has been stored in the `KV` namespace:
105-
1. Open the [Cloudflare dashboard](https://dash.cloudflare.com/) and go to **Workers & Pages** > **KV**.
105+
1. In the Cloudflare dashboard, go to the **Workers KV** page.
106+
<DashButton url="/?to=/:account/workers/kv/namespaces" />
106107
2. Select **View** next to `my-worker-KV`.
107108

108109
Other key formats (such as DSA) are not supported at this time.

src/content/docs/d1/best-practices/read-replication.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar:
66
badge: Beta
77
---
88

9-
import { GlossaryTooltip, Details, GitHubCode, APIRequest, Tabs, TabItem, TypeScriptExample } from "~/components"
9+
import { GlossaryTooltip, Details, GitHubCode, APIRequest, Tabs, TabItem, TypeScriptExample, DashButton } from "~/components"
1010

1111
D1 read replication can lower latency for read queries and scale read throughput by adding read-only database copies, called read replicas, across regions globally closer to clients.
1212

@@ -69,7 +69,9 @@ D1 read replication achieves this by attaching a <GlossaryTooltip term="bookmark
6969

7070
Read replication can be enabled at the database level in the Cloudflare dashboard. Check **Settings** for your D1 database to view if read replication is enabled.
7171

72-
1. Go to [**Workers & Pages** > **D1**](https://dash.cloudflare.com/?to=/:account/workers/d1).
72+
1. In the Cloudflare dashboard, go to the **D1** page.
73+
74+
<DashButton url="/?to=/:account/workers/d1" />
7375
2. Select an existing database > **Settings** > **Enable Read Replication**.
7476

7577
### Start a session without constraints
@@ -408,7 +410,7 @@ To see the impact of read replication and check the how D1 requests are processe
408410
- The `meta` object within the [`D1Result`](/d1/worker-api/return-object/#d1result) return object, which includes new fields:
409411
- `served_by_region`
410412
- `served_by_primary`
411-
- The [Cloudflare dashboard](https://dash.cloudflare.com/?to=/:account/workers/d1), where you can view your database metrics breakdown by region that processed D1 requests.
413+
- The Cloudflare dashboard, where you can view your database metrics breakdown by region that processed D1 requests.
412414

413415
## Pricing
414416
D1 read replication is built into D1, so you don’t pay extra storage or compute costs for read replicas. You incur the exact same D1 [usage billing](/d1/platform/pricing/#billing-metrics) with or without replicas, based on `rows_read` and `rows_written` by your queries.

src/content/docs/d1/best-practices/remote-development.mdx

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
---
22
title: Remote development
33
pcx_content_type: concept
4+
reviewed: 2025-09-02
45
sidebar:
56
order: 9
67

78
---
89

10+
import { DashButton } from "~/components";
11+
912
D1 supports remote development using the [dashboard playground](/workers/playground/#use-the-playground). The dashboard playground uses a browser version of Visual Studio Code, allowing you to rapidly iterate on your Worker entirely in your browser.
1013

1114
## 1. Bind a D1 database to a Worker
@@ -20,14 +23,15 @@ Users new to D1 and/or Cloudflare Workers should read the [D1 tutorial](/d1/get-
2023

2124
:::
2225

23-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account.
24-
2. Go to [**Workers & Pages** > **Overview**](https://dash.cloudflare.com/?to=/:account/workers-and-pages).
25-
3. Select an existing Worker.
26-
4. Select the **Settings** tab.
27-
5. Select the **Variables** sub-tab.
28-
6. Scroll down to the **D1 Database Bindings** heading.
29-
7. Enter a variable name, such as `DB`, and select the D1 database you wish to access from this Worker.
30-
8. Select **Save and deploy**.
26+
1. In the Cloudflare dashboard, go to the **Workers & Pages** page.
27+
28+
<DashButton url="/?to=/:account/workers-and-pages" />
29+
2. Select an existing Worker.
30+
3. Go to the **Bindings** tab.
31+
4. Select **Add binding**.
32+
5. Select **D1 database** > **Add binding**.
33+
6. Enter a variable name, such as `DB`, and select the D1 database you wish to access from this Worker.
34+
7. Select **Add binding**.
3135

3236
## 2. Start a remote development session
3337

src/content/docs/d1/configuration/data-location.mdx

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

8+
import { DashButton } from "~/components";
9+
810
Learn how the location of data stored in D1 is determined, including where the leader is placed and how you optimize that location based on your needs.
911

1012
## Automatic (recommended)
@@ -46,11 +48,12 @@ wrangler d1 create new-database --location=weur
4648

4749
To provide a location hint when creating a database via the dashboard:
4850

49-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account.
50-
2. Go to [**Workers & Pages** > **D1**](https://dash.cloudflare.com/?to=/:account/workers/d1).
51-
3. Select **Create database**.
52-
4. Provide a database name and an optional **Location**.
53-
5. Select **Create** to create your database.
51+
1. In the Cloudflare dashboard, go to the **D1** page.
52+
53+
<DashButton url="/?to=/:account/workers/d1" />
54+
2. Select **Create database**.
55+
3. Provide a database name and an optional **Location**.
56+
4. Select **Create** to create your database.
5457

5558
## Available location hints
5659

src/content/docs/d1/get-started.mdx

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar:
66
order: 2
77
---
88

9-
import { Render, PackageManagers, Steps, FileTree, Tabs, TabItem, TypeScriptExample, WranglerConfig } from "~/components";
9+
import { Render, PackageManagers, Steps, FileTree, Tabs, TabItem, TypeScriptExample, WranglerConfig, DashButton } from "~/components";
1010

1111
This guide instructs you through:
1212

@@ -89,12 +89,12 @@ For example: `CI=true npm create cloudflare@latest d1-tutorial --type=simple --g
8989
</TabItem> <TabItem label='Dashboard'>
9090

9191
<Steps>
92-
1. Log in to your [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
93-
2. Go to your account > **Compute (Workers)** > **Workers & Pages**.
94-
3. Select **Create**.
95-
4. Under **Start from a template**, select **Hello world**.
96-
5. Name your Worker. For this tutorial, name your Worker `d1-tutorial`.
97-
6. Select **Deploy**.
92+
1. In the Cloudflare dashboard, go to the **Workers & Pages** page.
93+
<DashButton url="/?to=/:account/workers-and-pages" />
94+
2. Select **Create application**.
95+
3. Select **Start with Hello World!** > **Get started**.
96+
4. Name your Worker. For this tutorial, name your Worker `d1-tutorial`.
97+
5. Select **Deploy**.
9898
</Steps>
9999
</TabItem> </Tabs>
100100

@@ -148,7 +148,9 @@ This creates a new D1 database and outputs the [binding](/workers/runtime-apis/b
148148
</TabItem> <TabItem label='Dashboard'>
149149

150150
<Steps>
151-
1. Go to **Storage & Databases** > **D1 SQL Database**.
151+
1. In the Cloudflare dashboard, go to the **D1 SQL database** page.
152+
153+
<DashButton url="/?to=/:account/workers/d1" />
152154
2. Select **Create Database**.
153155
3. Name your database. For this tutorial, name your D1 database `prod-d1-tutorial`.
154156
4. (Optional) Provide a location hint. Location hint is an optional parameter you can provide to indicate your desired geographical location for your database. Refer to [Provide a location hint](/d1/configuration/data-location/#provide-a-location-hint) for more information.
@@ -216,18 +218,14 @@ You can also bind your D1 database to a [Pages Function](/pages/functions/). For
216218
You create bindings by adding them to the Worker you have created.
217219

218220
<Steps>
219-
1. Go to **Compute (Workers)** > **Workers & Pages**.
221+
1. In the Cloudflare dashboard, go to the **Workers & Pages** page.
222+
<DashButton url="/?to=/:account/workers-and-pages" />
220223
2. Select the `d1-tutorial` Worker you created in [step 1](/d1/get-started/#1-create-a-worker).
221-
3. Select **Settings**.
222-
4. Scroll to **Bindings**, then select **Add**.
223-
5. Select **D1 database**.
224+
3. Go to the **Bindings** tab.
225+
4. Select **Add binding**.
226+
5. Select **D1 database** > **Add binding**.
224227
6. Name your binding in **Variable name**, then select the `prod-d1-tutorial` D1 database you created in [step 2](/d1/get-started/#2-create-a-database) from the dropdown menu. For this tutorial, name your binding `prod_d1_tutorial`.
225-
7. Select **Deploy** to deploy your binding. When deploying, there are two options:
226-
- **Deploy:** Immediately deploy the binding to 100% of your audience.
227-
- **Save version:** Save a version of the binding which you can deploy in the future.
228-
229-
For this tutorial, select **Deploy**.
230-
228+
7. Select **Add binding**.
231229
</Steps>
232230

233231
</TabItem>
@@ -298,7 +296,8 @@ After correctly preparing your [Wrangler configuration file](/workers/wrangler/c
298296
Use the Dashboard to create a table and populate it with data.
299297

300298
<Steps>
301-
1. Go to **Storage & Databases** > **D1 SQL Database**.
299+
1. In the Cloudflare dashboard, go to the **D1 SQL database** page.
300+
<DashButton url="/?to=/:account/workers/d1" />
302301
2. Select the `prod-d1-tutorial` database you created in [step 2](/d1/get-started/#2-create-a-database).
303302
3. Select **Console**.
304303
4. Paste the following SQL snippet.
@@ -399,7 +398,8 @@ After configuring your Worker, you can test your project locally before you depl
399398
You can query your D1 database using your Worker.
400399

401400
<Steps>
402-
1. Go to **Compute (Workers)** > **Workers & Pages**.
401+
1. In the Cloudflare dashboard, go to the **Workers & Pages** page.
402+
<DashButton url="/?to=/:account/workers-and-pages" />
403403
2. Select the `d1-tutorial` Worker you created.
404404
3. Select the **Edit code** icon (**\<\/\>**).
405405
4. Clear the contents of the `worker.js` file, then paste the following code:
@@ -521,7 +521,8 @@ To deploy your Worker to production using Wrangler, you must first repeat the [d
521521
</TabItem> <TabItem label='Dashboard'>
522522
<Steps>
523523

524-
1. Go to **Compute (Workers)** > **Workers & Pages**.
524+
1. In the Cloudflare dashboard, go to the **Workers & Pages** page.
525+
<DashButton url="/?to=/:account/workers-and-pages" />
525526
2. Select your `d1-tutorial` Worker.
526527
3. Select **Deployments**.
527528
4. From the **Version History** table, select **Deploy version**.
@@ -575,7 +576,8 @@ npx wrangler d1 delete prod-d1-tutorial
575576
</TabItem><TabItem label='Dashboard'>
576577

577578
<Steps>
578-
1. Go to **Storages & Databases** > **D1 SQL Database**.
579+
1. In the Cloudflare dashboard, go to the **D1 SQL database** page.
580+
<DashButton url="/?to=/:account/workers/d1" />
579581

580582
2. Select your `prod-d1-tutorial` D1 database.
581583

@@ -606,7 +608,8 @@ npx wrangler delete d1-tutorial
606608
</TabItem> <TabItem label='Dashboard'>
607609

608610
<Steps>
609-
1. Go to **Compute (Workers)** > **Workers & Pages**.
611+
1. In the Cloudflare dashboard, go to the **Workers & Pages** page.
612+
<DashButton url="/?to=/:account/workers-and-pages" />
610613

611614
2. Select your `d1-tutorial` Worker.
612615

src/content/docs/d1/observability/audit-logs.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@ pcx_content_type: reference
33
title: Audit Logs
44
---
55

6+
import { DashButton } from "~/components";
7+
68
[Audit logs](/fundamentals/account/account-security/review-audit-logs/) provide a comprehensive summary of changes made within your Cloudflare account, including those made to D1 databases. This functionality is available on all plan types, free of charge, and is always enabled.
79

810
## Viewing audit logs
911

10-
To view audit logs for your D1 databases:
12+
To view audit logs for your D1 databases, go to the **Audit Logs** page.
1113

12-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/?account=audit-log) and select your account.
13-
2. Go to **Manage Account** > **Audit Log**.
14+
<DashButton url="/?to=/:account/audit-log" />
1415

1516
For more information on how to access and use audit logs, refer to [Review audit logs](/fundamentals/account/account-security/review-audit-logs/).
1617

src/content/docs/d1/observability/billing.mdx

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

8+
import { DashButton } from "~/components";
89

910
D1 exposes analytics to track billing metrics (rows read, rows written, and total storage) across all databases in your account.
1011

@@ -14,9 +15,10 @@ The metrics displayed in the [Cloudflare dashboard](https://dash.cloudflare.com/
1415

1516
Total account billable usage analytics for D1 are available in the Cloudflare dashboard. To view current and past metrics for an account:
1617

17-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account.
18-
2. Go to **Manage Account** > **Billing**.
19-
3. Select the **Billable Usage** tab.
18+
1. In the Cloudflare dashboard, go to the **Billing** page.
19+
20+
<DashButton url="/?to=/:account/billing" />
21+
2. Go to **Billable Usage**.
2022

2123
From here you can view charts of your account's D1 usage on a daily or month-to-date timeframe.
2224

src/content/docs/d1/observability/metrics-analytics.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
pcx_content_type: concept
33
title: Metrics and analytics
4+
reviewed: 2025-09-02
45
sidebar:
56
order: 10
67
---
78

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

1011
D1 exposes database analytics that allow you to inspect query volume, query latency, and storage size across all and/or each database in your account.
1112

@@ -40,10 +41,11 @@ Refer to the [Pricing documentation](/d1/platform/pricing/) for more details on
4041

4142
Per-database analytics for D1 are available in the Cloudflare dashboard. To view current and historical metrics for a database:
4243

43-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account.
44-
2. Go to [**Workers & Pages** > **D1**](https://dash.cloudflare.com/?to=/:account/workers/d1).
45-
3. Select an existing database.
46-
4. Select the **Metrics** tab.
44+
1. In the Cloudflare dashboard, go to the **D1** page.
45+
46+
<DashButton url="/?to=/:account/workers/d1" />
47+
2. Select an existing D1 database.
48+
3. Select the **Metrics** tab.
4749

4850
You can optionally select a time window to query. This defaults to the last 24 hours.
4951

src/content/docs/d1/tutorials/import-to-d1-with-rest-api/index.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ tags:
1010
- SQL
1111
---
1212

13-
import { Render, Steps, PackageManagers } from "~/components";
13+
import { Render, Steps, PackageManagers, DashButton } from "~/components";
1414

1515
In this tutorial, you will learn how to import a database into D1 using the [REST API](/api/resources/d1/subresources/database/methods/import/).
1616

@@ -38,8 +38,10 @@ To create the table, follow these steps:
3838

3939
<Steps>
4040

41-
1. Go to **Storage & Databases** > **D1**.
42-
2. Select **Create**.
41+
1. In the Cloudflare dashboard, go to the **D1** page.
42+
43+
<DashButton url="/?to=/:account/workers/d1" />
44+
2. Select **Create database**.
4345
3. Name your database. For this tutorial, name your D1 database `d1-import-tutorial`.
4446
4. (Optional) Provide a location hint. Location hint is an optional parameter you can provide to indicate your desired geographical location for your database. Refer to [Provide a location hint](/d1/configuration/data-location/#provide-a-location-hint) for more information.
4547
5. Select **Create**.
@@ -80,8 +82,8 @@ To create the table, follow these steps:
8082
3. In your `index.js` file, define the following variables:
8183

8284
- `TARGET_TABLE`: The target table name
83-
- `ACCOUNT_ID`: The account ID (you can find this in the Cloudflare dashboard > **Workers & Pages**)
84-
- `DATABASE_ID`: The D1 database ID (you can find this in the Cloudflare dashboard > **Storage & Databases** > **D1 SQL Database** > your database)
85+
- `ACCOUNT_ID`: The account ID. Refer to **Account Details** in **Workers & Pages**.
86+
- `DATABASE_ID`: The D1 database ID. Go to your data base to see your database ID.
8587
- `D1_API_KEY`: The D1 API token generated in [step 1](/d1/tutorials/import-to-d1-with-rest-api#1-create-a-d1-api-token)
8688

8789
:::caution

src/content/docs/durable-objects/get-started.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import {
1212
PackageManagers,
1313
WranglerConfig,
1414
TypeScriptExample,
15+
DashButton
1516
} from "~/components";
1617

1718
This guide will instruct you through:
@@ -304,7 +305,9 @@ To deploy your Durable Object Worker:
304305
npx wrangler deploy
305306
```
306307

307-
Once deployed, you should be able to see your newly created Durable Object Worker on the [Cloudflare dashboard](https://dash.cloudflare.com/), **Workers & Pages** > **Overview**.
308+
Once deployed, you should be able to see your newly created Durable Object Worker on the Cloudflare dashboard.
309+
310+
<DashButton url="/?to=/:account/workers-and-pages" />
308311

309312
Preview your Durable Object Worker at `<YOUR_WORKER>.<YOUR_SUBDOMAIN>.workers.dev`.
310313

0 commit comments

Comments
 (0)