Skip to content

Commit 7ed3c12

Browse files
ToriLindsayelithrar
authored andcommitted
Suggesting changes for Workers get started guides (#17164)
1 parent 31f3fdb commit 7ed3c12

File tree

2 files changed

+23
-15
lines changed

2 files changed

+23
-15
lines changed

src/content/docs/workers/get-started/dashboard.mdx

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,34 @@ head:
1111

1212
import { Render } from "~/components"
1313

14-
Follow this guide to create a Workers application using the Cloudflare dashboard.
14+
Follow this guide to create a Workers application using [the Cloudflare dashboard](https://dash.cloudflare.com).
1515

1616
<Render file="playground-callout" />
1717

1818
## Prerequisites
1919

20-
Sign up for a [Cloudflare account](https://dash.cloudflare.com/sign-up/workers-and-pages) if you have not already.
20+
[Create a Cloudflare account](/learning-paths/get-started/account-setup/create-account/), if you have not already.
2121

2222
## Setup
2323

2424
To create a Workers application:
2525

2626
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account.
2727
2. Go to **Workers & Pages**.
28-
3. Select **Create application**.
28+
3. Select **Create**.
2929
4. Select a template or **Create Worker**.
3030
5. Review the provided code and select **Deploy**.
3131
6. Preview your Worker at its provided [`workers.dev`](/workers/configuration/routing/workers-dev/) subdomain.
3232

3333
## Development
3434

3535
<Render file="dash-creation-next-steps" />
36+
37+
## Next steps
38+
39+
To do more:
40+
41+
- Review our [Examples](/workers/examples/) and [Tutorials](/workers/tutorials/) for inspiration.
42+
- Set up [bindings](/workers/runtime-apis/bindings/) to allow your Worker to interact with other resources and unlock new functionality.
43+
- Learn how to [test and debug](/workers/testing/) your Workers.
44+
- Read about [Workers limits and pricing](/workers/platform/).

src/content/docs/workers/get-started/guide.mdx

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@ This guide will instruct you through setting up and deploying your first Worker.
2020

2121
## 1. Create a new Worker project
2222

23-
[C3 (`create-cloudflare-cli`)](https://github.com/cloudflare/workers-sdk/tree/main/packages/create-cloudflare) is a command-line tool designed to help you set up and deploy new applications to Cloudflare.
24-
25-
Open a terminal window and run C3 to create your Worker project:
23+
Open a terminal window and run C3 to create your Worker project. [C3 (`create-cloudflare-cli`)](https://github.com/cloudflare/workers-sdk/tree/main/packages/create-cloudflare) is a command-line tool designed to help you set up and deploy new applications to Cloudflare.
2624

2725
<PackageManagers
2826
type="create"
@@ -50,11 +48,11 @@ cd my-first-worker
5048

5149
In your project directory, C3 will have generated the following:
5250

53-
1. `wrangler.toml`: Your [Wrangler](/workers/wrangler/configuration/#sample-wranglertoml-configuration) configuration file.
54-
2. `index.js` (in `/src`): A minimal `'Hello World!'` Worker written in [ES module](/workers/reference/migrate-to-module-workers/) syntax.
55-
3. `package.json`: A minimal Node dependencies configuration file.
56-
4. `package-lock.json`: Refer to [`npm` documentation on `package-lock.json`](https://docs.npmjs.com/cli/v9/configuring-npm/package-lock-json).
57-
5. `node_modules`: Refer to [`npm` documentation `node_modules`](https://docs.npmjs.com/cli/v7/configuring-npm/folders#node-modules).
51+
* `wrangler.toml`: Your [Wrangler](/workers/wrangler/configuration/#sample-wranglertoml-configuration) configuration file.
52+
* `index.js` (in `/src`): A minimal `'Hello World!'` Worker written in [ES module](/workers/reference/migrate-to-module-workers/) syntax.
53+
* `package.json`: A minimal Node dependencies configuration file.
54+
* `package-lock.json`: Refer to [`npm` documentation on `package-lock.json`](https://docs.npmjs.com/cli/v9/configuring-npm/package-lock-json).
55+
* `node_modules`: Refer to [`npm` documentation `node_modules`](https://docs.npmjs.com/cli/v7/configuring-npm/folders#node-modules).
5856

5957
</Details>
6058

@@ -87,15 +85,15 @@ At a minimum, template folders must contain the following:
8785

8886
## 2. Develop with Wrangler CLI
8987

90-
The Workers command-line interface, [Wrangler](/workers/wrangler/install-and-update/), allows you to [create](/workers/wrangler/commands/#init), [test](/workers/wrangler/commands/#dev), and [deploy](/workers/wrangler/commands/#deploy) your Workers projects. C3 will install Wrangler in projects by default.
88+
C3 installs [Wrangler](/workers/wrangler/install-and-update/), the Workers command-line interface, in Workers projects by default. Wrangler lets you to [create](/workers/wrangler/commands/#init), [test](/workers/wrangler/commands/#dev), and [deploy](/workers/wrangler/commands/#deploy) your Workers projects.
9189

9290
After you have created your first Worker, run the [`wrangler dev`](/workers/wrangler/commands/#dev) command in the project directory to start a local server for developing your Worker. This will allow you to preview your Worker locally during development.
9391

9492
```sh
9593
npx wrangler dev
9694
```
9795

98-
If you have not used Wrangler before, it will try to open your web browser to login with your Cloudflare account.
96+
If you have never used Wrangler before, it will open your web browser so you can login to your Cloudflare account.
9997

10098
Go to [http://localhost:8787](http://localhost:8787) to view your Worker.
10199

@@ -191,16 +189,17 @@ If you have not configured any subdomain or domain, Wrangler will prompt you dur
191189

192190
Preview your Worker at `<YOUR_WORKER>.<YOUR_SUBDOMAIN>.workers.dev`.
193191

194-
<Details header="Encountering errors?">
192+
<Details header="Seeing 523 errors?">
195193

196-
When pushing to your `*.workers.dev` subdomain for the first time, you may see [`523` errors](/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors/#error-523-origin-is-unreachable) while DNS is propagating. These errors should resolve themselves after a minute or so.
194+
If you see [`523` errors](/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors/#error-523-origin-is-unreachable) when pushing your `*.workers.dev` subdomain for the first time, wait a minute or so and the errors will resolve themselves.
197195

198196
</Details>
199197

200198
## Next steps
201199

202200
To do more:
203201

202+
- Visit the [Cloudlfare dashboard](https://dash.cloudflare.com/) for simpler editing.
204203
- Review our [Examples](/workers/examples/) and [Tutorials](/workers/tutorials/) for inspiration.
205204
- Set up [bindings](/workers/runtime-apis/bindings/) to allow your Worker to interact with other resources and unlock new functionality.
206205
- Learn how to [test and debug](/workers/testing/) your Workers.

0 commit comments

Comments
 (0)