Skip to content

[Workflows] Nits #17758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 24, 2024
Merged

[Workflows] Nits #17758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e5155a2
Add hyperlinks
markdembo Oct 24, 2024
3dac28b
Fix language error
markdembo Oct 24, 2024
61790f6
Replace silverlock with generic
markdembo Oct 24, 2024
30321fe
Make params match the example types from section above
markdembo Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/content/docs/workflows/get-started/cli-quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ You can run a Workflow via the `wrangler` CLI, via a Worker binding, or via the

```sh
# Trigger a Workflow from the CLI, and pass (optional) parameters as an event to the Workflow.
npx wrangler@latest workflows trigger workflows-tutorial --params={"hello":"world"}
npx wrangler@latest workflows trigger workflows-tutorial --params={"email": "[email protected]", "metadata": {"id": "1"}}
```

Refer to the [events and parameters documentation](/workflows/build/events-and-parameters/) to understand how events are passed to Workflows.
Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/workflows/get-started/guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,9 @@ When trying to decide whether to break code up into more than one step, a good r

For example, each of the below tasks is ideally encapsulated in its own step, so that any failure — such as a file not existing, a third-party API being down or rate limited — does not cause your entire program to fail.

* Reading or writing files from R2
* Reading or writing files from [R2](/r2/)
* Running an AI task using [Workers AI](/workers-ai/)
* Querying a D1 database or a database via [Hyperdrive](/hyperdrive/)
* Querying a [D1 database](/d1/) or a database via [Hyperdrive](/hyperdrive/)
* Calling a third-party API

If a subsequent step fails, your Workflow can retry from that step, using any state returned from a previous step. This can also help you avoid unnecessarily querying a database or calling an paid API repeatedly for data you have already fetched.
Expand Down Expand Up @@ -159,7 +159,7 @@ name = "workflows-starter"
binding = "MY_WORKFLOW"
# this is class that extends the Workflow class in src/index.ts
class_name = "MyWorkflow"
# script_name is required during for the beta.
# script_name is required during the beta.
# Must match the "name" of your Worker at the top of wrangler.toml
script_name = "workflows-starter"
```
Expand Down Expand Up @@ -328,7 +328,7 @@ Your worker has access to the following bindings:
- MY_WORKFLOW: MyWorkflow (defined in workflows-starter)
Uploaded workflows-starter (2.53 sec)
Deployed workflows-starter triggers (1.12 sec)
https://workflows-starter.silverlock.workers.dev
https://workflows-starter.YOUR_WORKERS_SUBDOMAIN.workers.dev
workflow: workflows-starter
```

Expand Down
Loading