Skip to content

Commit 3127df5

Browse files
Add new Bulk Actions section to documentation (#1649)
* Documentation edits made through Mintlify web editor * Moves files to correct path and improves copy * Corrects video props to camel case and removes deprecated prop * Link to the new bulk actions page from the replaying page --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: James Ritchie <james@trigger.dev>
1 parent 9fd175e commit 3127df5

10 files changed

+69
-88
lines changed

docs/bulk-actions.mdx

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "Bulk actions"
3+
description: "Perform actions like replay and cancel on multiple runs at once."
4+
---
5+
6+
Bulk actions allow you to perform operations like replaying or canceling on multiple runs at once. This is especially useful when you need to retry a batch of failed runs with a new version of your code, or when you need to cancel multiple in-progress runs.
7+
8+
## Bulk replaying
9+
10+
You can replay multiple runs at once by selecting them from the table on the Runs page using the checkbox on the left hand side of the row. Then click the "Replay runs" button from the bulk action bar that appears at the bottom of the screen.
11+
12+
This is especially useful if you have lots of failed runs and want to run them all again. To do this, first filter the runs by the status you want, then select all the runs you want to replay and click the "Replay runs" button from the bulk action bar at the bottom of the page.
13+
14+
<video
15+
src="https://content.trigger.dev/bulk-replaying-runs.mp4"
16+
preload="auto"
17+
controls={true}
18+
loop
19+
muted
20+
autoPlay={true}
21+
width="100%"
22+
height="100%"
23+
/>
24+
25+
## Bulk canceling
26+
27+
Similar to replaying multiple runs, you can cancel multiple runs at once. This is particularly useful when you have a batch of runs that you want to stop, perhaps because they were triggered with incorrect parameters or are no longer needed.
28+
29+
To cancel multiple runs:
30+
31+
1. Filter the runs table to show the runs you want to cancel (e.g., all runs with status "QUEUED" or "EXECUTING")
32+
2. Use the checkboxes on the left side of the runs table to select the runs you want to cancel
33+
3. Click the "Cancel runs" button in the bulk action bar that appears at the bottom of the screen
34+
35+
After confirming, all selected runs that can be canceled (those in appropriate states like QUEUED or EXECUTING) will be canceled. The status of these runs will change to "CANCELED" and they will not be resumed.
36+
37+
<Note>
38+
You can only cancel runs that are in states that allow cancellation (like QUEUED or EXECUTING).
39+
Runs that are already completed, failed, or in other final states cannot be canceled.
40+
</Note>

docs/guides/example-projects/realtime-fal-ai.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,9 @@ This video walks through the process of creating this task in a Next.js project.
3636
height="100%"
3737
src="https://www.youtube.com/embed/BWZqYfUaigg?si=XpqVUEIf1j4bsYZ4"
3838
title="Trigger.dev walkthrough"
39-
frameborder="0"
4039
allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
41-
referrerpolicy="strict-origin-when-cross-origin"
42-
allowfullscreen
40+
referrerPolicy="strict-origin-when-cross-origin"
41+
allowFullScreen
4342
/>
4443
</div>
4544

docs/guides/examples/fal-ai-image-to-cartoon.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: "This example task generates an image from a URL using Fal.ai and u
99
This video walks through the process of creating this task in a Next.js project.
1010

1111
<div className="w-full h-full aspect-video mb-3">
12-
<iframe width="100%" height="100%" src="https://www.youtube.com/embed/AyRT4X8dHK0?si=ugA172V_3TMjik9h" title="Trigger.dev walkthrough" frameborder="0" allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen/>
12+
<iframe width="100%" height="100%" src="https://www.youtube.com/embed/AyRT4X8dHK0?si=ugA172V_3TMjik9h" title="Trigger.dev walkthrough" allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen/>
1313
</div>
1414

1515
## Prerequisites

docs/guides/examples/fal-ai-realtime.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,9 @@ This video walks through the process of creating this task in a Next.js project.
2525
height="100%"
2626
src="https://www.youtube.com/embed/BWZqYfUaigg?si=XpqVUEIf1j4bsYZ4"
2727
title="Trigger.dev walkthrough"
28-
frameborder="0"
2928
allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
30-
referrerpolicy="strict-origin-when-cross-origin"
31-
allowfullscreen
29+
referrerPolicy="strict-origin-when-cross-origin"
30+
allowFullScreen
3231
/>
3332
</div>
3433

docs/guides/examples/scrape-hacker-news.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,9 @@ import ScrapingWarning from "/snippets/web-scraping-warning.mdx";
1313
height="100%"
1414
src="https://www.youtube.com/embed/6azvzrZITKY?si=muKtsBiS9TJGGKWg"
1515
title="YouTube video player"
16-
frameborder="0"
1716
allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
18-
referrerpolicy="strict-origin-when-cross-origin"
19-
allowfullscreen
17+
referrerPolicy="strict-origin-when-cross-origin"
18+
allowFullScreen
2019
/>
2120
</div>
2221

docs/introduction.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,9 @@ We're [open source](https://github.com/triggerdotdev/trigger.dev) and you can ch
2424
height="100%"
2525
src="https://www.youtube.com/embed/YH_4c0K7fGM?si=5JzZmZseuqI5aciM"
2626
title="Trigger.dev walkthrough"
27-
frameborder="0"
2827
allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
29-
referrerpolicy="strict-origin-when-cross-origin"
30-
allowfullscreen
28+
referrerPolicy="strict-origin-when-cross-origin"
29+
allowFullScreen
3130
/>
3231
</div>
3332

docs/mint.json

Lines changed: 16 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
{
22
"$schema": "https://mintlify.com/schema.json",
33
"name": "Trigger.dev",
4-
"openapi": [
5-
"/openapi.yml",
6-
"/v3-openapi.yaml"
7-
],
4+
"openapi": ["/openapi.yml", "/v3-openapi.yaml"],
85
"api": {
96
"playground": {
107
"mode": "simple"
@@ -126,43 +123,27 @@
126123
"navigation": [
127124
{
128125
"group": "Getting Started",
129-
"pages": [
130-
"introduction",
131-
"quick-start",
132-
"video-walkthrough",
133-
"how-it-works",
134-
"limits"
135-
]
126+
"pages": ["introduction", "quick-start", "video-walkthrough", "how-it-works", "limits"]
136127
},
137128
{
138129
"group": "Fundamentals",
139130
"pages": [
140131
{
141132
"group": "Tasks",
142-
"pages": [
143-
"tasks/overview",
144-
"tasks/schemaTask",
145-
"tasks/scheduled"
146-
]
133+
"pages": ["tasks/overview", "tasks/schemaTask", "tasks/scheduled"]
147134
},
148135
"triggering",
149136
"runs",
150137
"apikeys",
151138
{
152139
"group": "Configuration",
153-
"pages": [
154-
"config/config-file",
155-
"config/extensions/overview"
156-
]
140+
"pages": ["config/config-file", "config/extensions/overview"]
157141
}
158142
]
159143
},
160144
{
161145
"group": "Development",
162-
"pages": [
163-
"cli-dev",
164-
"run-tests"
165-
]
146+
"pages": ["cli-dev", "run-tests"]
166147
},
167148
{
168149
"group": "Deployment",
@@ -172,9 +153,7 @@
172153
"github-actions",
173154
{
174155
"group": "Deployment integrations",
175-
"pages": [
176-
"vercel-integration"
177-
]
156+
"pages": ["vercel-integration"]
178157
}
179158
]
180159
},
@@ -186,13 +165,7 @@
186165
"errors-retrying",
187166
{
188167
"group": "Wait",
189-
"pages": [
190-
"wait",
191-
"wait-for",
192-
"wait-until",
193-
"wait-for-event",
194-
"wait-for-request"
195-
]
168+
"pages": ["wait", "wait-for", "wait-until", "wait-for-event", "wait-for-request"]
196169
},
197170
"queue-concurrency",
198171
"versioning",
@@ -203,7 +176,8 @@
203176
"tags",
204177
"runs/metadata",
205178
"run-usage",
206-
"context"
179+
"context",
180+
"bulk-actions"
207181
]
208182
},
209183
{
@@ -237,10 +211,7 @@
237211
"management/overview",
238212
{
239213
"group": "Tasks API",
240-
"pages": [
241-
"management/tasks/trigger",
242-
"management/tasks/batch-trigger"
243-
]
214+
"pages": ["management/tasks/trigger", "management/tasks/batch-trigger"]
244215
},
245216
{
246217
"group": "Runs API",
@@ -279,9 +250,7 @@
279250
},
280251
{
281252
"group": "Projects API",
282-
"pages": [
283-
"management/projects/runs"
284-
]
253+
"pages": ["management/projects/runs"]
285254
}
286255
]
287256
},
@@ -328,17 +297,11 @@
328297
},
329298
{
330299
"group": "Help",
331-
"pages": [
332-
"community",
333-
"help-slack",
334-
"help-email"
335-
]
300+
"pages": ["community", "help-slack", "help-email"]
336301
},
337302
{
338303
"group": "",
339-
"pages": [
340-
"guides/introduction"
341-
]
304+
"pages": ["guides/introduction"]
342305
},
343306
{
344307
"group": "Frameworks",
@@ -412,20 +375,16 @@
412375
},
413376
{
414377
"group": "Dashboard",
415-
"pages": [
416-
"guides/dashboard/creating-a-project"
417-
]
378+
"pages": ["guides/dashboard/creating-a-project"]
418379
},
419380
{
420381
"group": "Migrations",
421-
"pages": [
422-
"guides/use-cases/upgrading-from-v2"
423-
]
382+
"pages": ["guides/use-cases/upgrading-from-v2"]
424383
}
425384
],
426385
"footerSocials": {
427386
"twitter": "https://twitter.com/triggerdotdev",
428387
"github": "https://github.com/triggerdotdev",
429388
"linkedin": "https://www.linkedin.com/company/triggerdotdev"
430389
}
431-
}
390+
}

docs/realtime/overview.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,9 @@ The Realtime API is built on top of [Electric SQL](https://electric-sql.com/), a
1818
height="100%"
1919
src="https://www.youtube.com/embed/RhJAbSGkS88?si=4Z72SfygeklNI3As"
2020
title="YouTube video player"
21-
frameborder="0"
2221
allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
23-
referrerpolicy="strict-origin-when-cross-origin"
24-
allowfullscreen
22+
referrerPolicy="strict-origin-when-cross-origin"
23+
allowFullScreen
2524
></iframe>
2625
</div>
2726

docs/replaying.mdx

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -54,17 +54,4 @@ export const simpleChildTask = task({
5454

5555
### Bulk replaying
5656

57-
You can replay multiple runs at once by selecting them from the table on the Runs page using the checkbox on the left hand side of the row. Then click the "Replay runs" button from the bulk action bar that appears at the bottom of the screen.
58-
59-
This is especially useful if you have lots of failed runs and want to run them all again. To do this, first filter the runs by the status you want, then select all the runs you want to replay and click the "Replay runs" button from the bulk action bar at the bottom of the page.
60-
61-
<video
62-
src="https://content.trigger.dev/bulk-replaying-runs.mp4"
63-
preload="auto"
64-
controls={true}
65-
loop
66-
muted
67-
autoPlay={true}
68-
width="100%"
69-
height="100%"
70-
/>
57+
See [Bulk actions](/bulk-actions) for more information.

docs/video-walkthrough.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Go from zero to a working task in your Next.js app in 10 minutes."
44
---
55

66
<div className="w-full h-full aspect-video">
7-
<iframe width="100%" height="100%" src="https://www.youtube.com/embed/YH_4c0K7fGM?si=5JzZmZseuqI5aciM" title="Trigger.dev walkthrough" frameborder="0" allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen/>
7+
<iframe width="100%" height="100%" src="https://www.youtube.com/embed/YH_4c0K7fGM?si=5JzZmZseuqI5aciM" title="Trigger.dev walkthrough" allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen/>
88
</div>
99

1010
### In this video we cover the following topics:

0 commit comments

Comments
 (0)