Skip to content

Commit 5059373

Browse files
samejrsamejr
committed
Replaced v1 docs content with v2
1 parent 3bb7fc3 commit 5059373

File tree

582 files changed

+32143
-14650
lines changed

Some content is hidden

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

582 files changed

+32143
-14650
lines changed

‎LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎README.md

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,14 @@
1-
Note: the docs have moved to [the main repository](https://github.com/triggerdotdev/trigger.dev).
1+
# Development
22

3-
# Trigger.dev Documentation
3+
## Install and initial setup
44

5-
This repository contains the documentation for [Trigger.dev](https://trigger.dev).
5+
`pnpm install`
66

7-
View the live documentation at [docs.trigger.dev](https://docs.trigger.dev).
7+
## Running the app
88

9-
### 👩‍💻 Development
9+
`pnpm run dev --filter docs`
1010

11-
If you wish to run this locally, follow the steps below.
11+
## View the app locally
1212

13-
Run these from the root of the repository
14-
15-
```
16-
pnpm install
17-
```
18-
19-
```
20-
pnpm run dev
21-
```
22-
23-
Go to http://localhost:3050
24-
25-
### 😎 Publishing Changes
26-
27-
Changes will be deployed to production automatically after pushing to the `main` branch.
28-
29-
You can also preview changes using PRs, which generates a preview link of the docs.
30-
31-
#### Troubleshooting
32-
33-
- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
34-
- Mintlify dev is updating really slowly - Run `mintlify clear` to clear the cache.
13+
It runs locally here:
14+
`http://localhost:3050`

‎_snippets/beta-feature-warning.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<Warning>This feature is in beta and has not yet been deployed to the Trigger.dev cloud</Warning>

‎_snippets/card-react-hooks.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<Card title="React hooks" icon="fishing-rod" href="/documentation/guides/react-hooks">
2+
Show the live status of Job Runs in your React app
3+
</Card>

‎_snippets/coming-soon-slim.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<Warning>This feature will become available during the Developer Preview.</Warning>

‎_snippets/coming-soon.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<Warning>This feature will become available during the Developer Preview.</Warning>
2+
3+
To get the latest updates on the Developer Preview, [join our Discord community](https://trigger.dev/discord) or follow us on [Twitter](https://twitter.com/triggerdotdev).

‎_snippets/delay-example.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
```typescript Wait example
2+
client.defineJob({
3+
id: "delay-job",
4+
name: "Delay Job",
5+
version: "0.0.1",
6+
trigger: eventTrigger({
7+
name: "example.event",
8+
}),
9+
run: async (payload, io, ctx) => {
10+
await io.logger.info("Hi");
11+
12+
// the second parameter is the number of seconds to wait
13+
await io.wait("wait 30 days", 30 * 24 * 60 * 60);
14+
15+
await io.logger.info("Sorry for the slow reply!");
16+
},
17+
});
18+
```

‎_snippets/faq/question-github-app.mdx

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎_snippets/frameworks/card-astro.mdx

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<Card
2+
icon={
3+
<svg
4+
width="150"
5+
height="49"
6+
viewBox="-38 0 226 49"
7+
fill="none"
8+
xmlns="http://www.w3.org/2000/svg"
9+
>
10+
<g clipPath="url(#clip0_5336_22429)">
11+
<mask id="mask0_5336_22429" maskUnits="userSpaceOnUse" x="0" y="0" width="184" height="49">
12+
<path d="M184 0H0V48.4533H184V0Z" fill="white" />
13+
</mask>
14+
<g mask="url(#mask0_5336_22429)">
15+
<path
16+
d="M12.4424 40.9986C10.2625 39.0108 9.62608 34.8341 10.5343 31.8083C12.1092 33.716 14.2912 34.3203 16.5514 34.6615C20.0406 35.1879 23.4674 34.991 26.7087 33.4002C27.0795 33.218 27.4221 32.9759 27.8273 32.7306C28.1315 33.6107 28.2106 34.4993 28.1044 35.4037C27.8461 37.6063 26.7472 39.3077 24.9995 40.5974C24.3006 41.1133 23.5611 41.5744 22.8393 42.0609C20.6218 43.5559 20.0219 45.3089 20.8551 47.8589C20.8749 47.921 20.8926 47.9831 20.9374 48.1347C19.8053 47.6293 18.9783 46.8934 18.3481 45.9258C17.6825 44.9046 17.3659 43.7749 17.3492 42.5525C17.3409 41.9577 17.3409 41.3576 17.2607 40.7711C17.0649 39.3413 16.3921 38.7013 15.1245 38.6644C13.8236 38.6265 12.7945 39.4287 12.5216 40.6921C12.5008 40.789 12.4706 40.8849 12.4404 40.9975L12.4424 40.9986Z"
17+
fill="url(#paint0_linear_5336_22429)"
18+
/>
19+
<path
20+
d="M0 31.3041C0 31.3041 6.45527 28.1673 12.9286 28.1673L17.8093 13.1001C17.992 12.3714 18.5256 11.8762 19.1278 11.8762C19.7302 11.8762 20.2637 12.3714 20.4464 13.1001L25.3271 28.1673C32.9938 28.1673 38.2557 31.3041 38.2557 31.3041C38.2557 31.3041 27.2909 1.50808 27.2694 1.44829C26.9547 0.567361 26.4234 0 25.7072 0H12.5496C11.8333 0 11.3235 0.567361 10.9874 1.44829C10.9637 1.50695 0 31.3041 0 31.3041Z"
21+
fill="white"
22+
/>
23+
<path
24+
d="M68.0598 26.9653C68.0598 29.6056 64.7674 31.1825 60.2089 31.1825C57.2422 31.1825 56.1929 30.4491 56.1929 28.9089C56.1929 27.2954 57.4954 26.5253 60.4622 26.5253C63.1396 26.5253 65.4188 26.5619 68.0598 26.892V26.9653ZM68.096 23.7016C66.4682 23.3349 64.0081 23.1149 61.0773 23.1149C52.5388 23.1149 48.5228 25.1318 48.5228 29.8257C48.5228 34.7029 51.2725 36.5731 57.6402 36.5731C63.031 36.5731 66.6853 35.2163 68.0236 31.8792H68.2407C68.2045 32.6859 68.1683 33.4927 68.1683 34.1161C68.1683 35.8396 68.4578 35.9864 69.8691 35.9864H76.5262C76.1644 34.9596 75.9472 32.0626 75.9472 29.5689C75.9472 26.892 76.0558 24.8751 76.0558 22.1615C76.0558 16.6241 72.7272 13.1037 62.3073 13.1037C57.821 13.1037 52.8282 13.8738 49.0293 15.0106C49.3911 16.5141 49.8977 19.5578 50.1509 21.538C53.4433 19.9979 58.1105 19.3378 61.7283 19.3378C66.7215 19.3378 68.096 20.4745 68.096 22.7848V23.7016Z"
25+
fill="white"
26+
/>
27+
<path
28+
d="M86.3622 28.5055C85.4576 28.6155 84.2278 28.6155 82.9613 28.6155C81.6224 28.6155 80.3927 28.5788 79.5604 28.4688C79.5604 28.7622 79.5242 29.0922 79.5242 29.3856C79.5242 33.9695 82.5271 36.6464 93.0917 36.6464C103.041 36.6464 106.261 34.0062 106.261 29.3489C106.261 24.9484 104.127 22.7848 94.6833 22.3081C87.3393 21.9781 86.6879 21.1713 86.6879 20.2545C86.6879 19.1911 87.6288 18.641 92.5489 18.641C97.6506 18.641 99.0251 19.3378 99.0251 20.8046V21.1346C99.7489 21.098 101.052 21.0613 102.39 21.0613C103.656 21.0613 105.031 21.098 105.827 21.1713C105.827 20.8413 105.863 20.5479 105.863 20.2912C105.863 14.9006 101.377 13.1404 92.6937 13.1404C82.9251 13.1404 79.6327 15.524 79.6327 20.1812C79.6327 24.3617 82.2738 26.9653 91.6443 27.3687C98.5547 27.5887 99.3146 28.3588 99.3146 29.4223C99.3146 30.559 98.1928 31.0725 93.345 31.0725C87.7735 31.0725 86.3622 30.3024 86.3622 28.7255V28.5055Z"
29+
fill="white"
30+
/>
31+
<path
32+
d="M118.203 9.17995C115.562 11.6369 110.822 14.0939 108.181 14.7539C108.217 16.1107 108.217 18.6044 108.217 19.9612L110.641 19.9979C110.605 22.6015 110.569 25.7552 110.569 27.8454C110.569 32.7226 113.137 36.3897 121.133 36.3897C124.498 36.3897 126.741 36.023 129.527 35.4363C129.237 33.6394 128.912 30.8891 128.804 28.7988C127.139 29.3489 125.041 29.6423 122.725 29.6423C119.505 29.6423 118.203 28.7622 118.203 26.2319C118.203 24.0316 118.203 21.9781 118.239 20.0712C122.364 20.1078 126.488 20.1812 128.912 20.2545C128.876 18.3477 128.948 15.5973 129.057 13.7638C125.547 13.8371 121.604 13.8738 118.348 13.8738C118.384 12.2603 118.42 10.7201 118.456 9.17995H118.203Z"
33+
fill="white"
34+
/>
35+
<path
36+
d="M139.812 18.861C139.848 16.9541 139.884 15.3406 139.92 13.7638H132.648C132.757 16.9175 132.757 20.1445 132.757 24.8751C132.757 29.6056 132.72 32.8693 132.648 35.9864H140.969C140.824 33.7861 140.788 30.0823 140.788 26.9286C140.788 21.9414 142.815 20.5112 147.409 20.5112C149.544 20.5112 151.063 20.768 152.402 21.2446C152.438 19.3745 152.8 15.744 153.017 14.1305C151.642 13.7271 150.123 13.4705 148.278 13.4705C144.334 13.4338 141.44 15.0473 140.101 18.8977L139.812 18.861Z"
37+
fill="white"
38+
/>
39+
<path
40+
d="M176.038 24.7284C176.038 28.7255 173.143 30.5957 168.584 30.5957C164.062 30.5957 161.167 28.8355 161.167 24.7284C161.167 20.6213 164.098 19.0811 168.584 19.0811C173.107 19.0811 176.038 20.7313 176.038 24.7284ZM183.599 24.5451C183.599 16.5875 177.376 13.0304 168.584 13.0304C159.757 13.0304 153.75 16.5875 153.75 24.5451C153.75 32.4659 159.359 36.7198 168.548 36.7198C177.81 36.7198 183.599 32.4659 183.599 24.5451Z"
41+
fill="white"
42+
/>
43+
</g>
44+
</g>
45+
<defs>
46+
<linearGradient
47+
id="paint0_linear_5336_22429"
48+
x1="10.1338"
49+
y1="48.1347"
50+
x2="31.1641"
51+
y2="38.1736"
52+
gradientUnits="userSpaceOnUse"
53+
>
54+
<stop stopColor="#D83333" />
55+
<stop offset="1" stopColor="#F041FF" />
56+
</linearGradient>
57+
<clipPath id="clip0_5336_22429">
58+
<rect width="184" height="48.4533" fill="white" />
59+
</clipPath>
60+
</defs>
61+
</svg>
62+
}
63+
href="/documentation/quickstarts/astro"
64+
/>

‎_snippets/frameworks/card-express.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<Card
2+
icon={
3+
<svg
4+
width="150"
5+
height="42"
6+
viewBox="-30 0 220 30"
7+
fill="none"
8+
xmlns="http://www.w3.org/2000/svg"
9+
>
10+
<g clipPath="url(#clip0_5334_22417)">
11+
<path
12+
d="M57.283 41.2316V1.22898H59.4528V7.52144C59.709 7.24242 59.9457 6.94604 60.1611 6.63442C61.9733 2.87457 65.7956 0.501664 69.9686 0.548532C74.9158 0.400984 78.936 2.23231 81.2985 6.63442C82.8019 9.3692 83.6291 12.424 83.7113 15.5436C83.7934 18.6633 83.128 21.7574 81.7706 24.5675C79.5696 29.5008 74.1329 31.9535 68.3126 31.0526C66.5013 30.8986 64.7573 30.2934 63.24 29.2922C61.7227 28.291 60.4804 26.9256 59.6264 25.3208V41.2299L57.283 41.2316ZM59.4528 15.3796L59.9389 20.0768C60.7964 25.4233 63.9574 28.5825 68.9201 29.1762C71.2507 29.5593 73.642 29.1224 75.6865 27.9398C77.731 26.7573 79.3021 24.9023 80.132 22.691C82.0623 18.091 81.9199 12.8835 79.7501 8.3911C78.8644 6.4089 77.3575 4.76886 75.4572 3.71882C73.557 2.66879 71.3665 2.26581 69.217 2.5708C67.1993 2.71758 65.2774 3.48911 63.7183 4.77821C62.1592 6.06732 61.0402 7.80999 60.5169 9.76415C60.0548 11.6134 59.6995 13.4878 59.4528 15.3779V15.3796ZM128.015 20.8163C127.686 23.6329 126.346 26.234 124.242 28.1361C122.139 30.0381 119.417 31.1115 116.581 31.1568C107.482 31.615 103.212 25.5725 102.533 18.5996C102.061 14.813 102.676 10.9702 104.305 7.5197C105.44 5.15268 107.298 3.2082 109.611 1.96795C111.924 0.727698 114.572 0.256089 117.172 0.621437C119.642 0.831463 121.985 1.81326 123.867 3.42787C125.749 5.04248 127.076 7.20813 127.66 9.61834C128.122 11.8139 128.462 14.0334 128.678 16.2666H104.781C104.338 22.5886 107.735 27.6712 112.551 28.8967C118.548 30.3722 123.674 27.7736 125.535 22.0713C125.948 20.608 126.701 20.4014 128.031 20.8163H128.015ZM104.764 14.2426H126.139C126.005 7.50755 121.811 2.61246 116.123 2.55691C109.7 2.45276 105.043 7.1517 104.764 14.2426ZM132.433 20.9639H134.528C134.605 22.5074 135.107 23.9998 135.977 25.2769C136.847 26.554 138.053 27.5663 139.462 28.2023C141.23 28.9983 143.156 29.3851 145.094 29.334C147.033 29.2829 148.935 28.7952 150.66 27.9072C151.599 27.4841 152.387 26.7825 152.915 25.8975C153.443 25.0124 153.687 23.9865 153.614 22.9583C153.668 21.9668 153.397 20.9846 152.843 20.1608C152.288 19.3369 151.48 18.7163 150.542 18.3931C148.236 17.5356 145.785 17.0634 143.437 16.31C140.993 15.6143 138.603 14.7405 136.287 13.6959C132.503 11.8489 132.268 4.65555 136.552 2.37812C138.746 1.1403 141.215 0.471475 143.733 0.432664C146.251 0.393854 148.74 0.986293 150.97 2.15593C153.737 3.68348 155.266 6.76808 154.812 9.89781H153.015C153.015 9.81102 152.852 9.73464 152.852 9.64612C152.63 3.91781 147.814 2.12642 142.645 2.62981C141.083 2.8034 139.602 3.27555 138.214 3.97336C137.379 4.35459 136.683 4.98585 136.223 5.7798C135.763 6.57375 135.56 7.49112 135.644 8.40498C135.646 9.31953 135.931 10.2111 136.46 10.9571C136.989 11.7031 137.736 12.2669 138.599 12.571C140.855 13.399 143.251 13.9302 145.586 14.5794L151.227 16.0549C152.509 16.4758 153.634 17.2759 154.451 18.3496C155.269 19.4233 155.742 20.7198 155.806 22.0679C156.258 25.0969 154.713 28.0739 151.981 29.4539C147.047 32.2451 138.922 31.5074 135.302 27.9784C133.45 26.1159 132.418 23.5867 132.438 20.9621L132.433 20.9639ZM182.391 9.89955H180.426C180.426 9.63396 180.322 9.37879 180.292 9.1757C180.261 7.70278 179.724 6.28543 178.772 5.16127C177.82 4.03711 176.51 3.2745 175.062 3.00129C172.331 2.21802 169.418 2.35837 166.775 3.40053C165.73 3.69961 164.81 4.32893 164.152 5.19438C163.495 6.05983 163.135 7.11492 163.126 8.20189C163.089 9.26919 163.421 10.3167 164.067 11.1672C164.713 12.0177 165.633 12.6191 166.671 12.8696L175.652 15.1748C176.624 15.4077 177.58 15.6987 178.516 16.0462C181.381 17.0877 183.325 19.747 183.412 22.7865C183.454 24.2743 183.046 25.7402 182.241 26.9918C181.435 28.2434 180.27 29.2221 178.898 29.7993C176.814 30.7462 174.554 31.2472 172.265 31.2702C169.976 31.2933 167.707 30.8378 165.603 29.933C163.874 29.1872 162.414 27.9294 161.421 26.3289C160.428 24.7284 159.949 22.8621 160.049 20.9812H161.969C162.691 24.4616 165.081 27.3605 168.36 28.7318C171.639 30.1031 175.383 29.7663 178.365 27.8361C179.26 27.3708 180.003 26.6588 180.506 25.7845C181.008 24.9102 181.25 23.9102 181.202 22.9028C181.246 21.9105 180.966 20.9308 180.403 20.1123C179.841 19.2937 179.027 18.681 178.084 18.367C175.779 17.5095 173.328 17.053 170.979 16.284C168.522 15.5989 166.118 14.7351 163.786 13.6993C160.092 11.8819 159.797 4.74755 164.008 2.47185C166.229 1.18209 168.746 0.489192 171.314 0.460598C173.882 0.432004 176.413 1.06869 178.662 2.30868C179.949 3.07637 180.984 4.20152 181.642 5.54711C182.301 6.8927 182.553 8.40067 182.37 9.8874L182.391 9.89955ZM53.7124 30.4346C52.9389 30.7271 52.0851 30.7263 51.3122 30.4325C50.5392 30.1386 49.9006 29.5719 49.5168 28.8394L41.8791 18.2768L40.7716 16.8013L31.9084 28.855C31.5471 29.556 30.9431 30.1015 30.209 30.3897C29.4749 30.6778 28.661 30.6889 27.9194 30.4208L39.3378 15.1019L28.7144 1.26023C30.2906 0.690871 32.0472 1.30883 32.9239 2.7357L40.8393 13.4285L48.8017 2.77736C49.1656 2.08838 49.7701 1.55719 50.5001 1.28482C51.2302 1.01245 52.0349 1.01791 52.7611 1.30016L48.6385 6.76981L43.0543 14.0378C42.8993 14.1762 42.7753 14.3458 42.6904 14.5355C42.6055 14.7251 42.5616 14.9306 42.5616 15.1383C42.5616 15.3461 42.6055 15.5516 42.6904 15.7412C42.7753 15.9309 42.8993 16.1005 43.0543 16.2389L53.6898 30.4346H53.7124ZM102.195 1.11268V3.1957C100.701 3.0977 99.2025 3.31407 97.7972 3.83084C96.3919 4.3476 95.1106 5.15329 94.0359 6.19589C92.9613 7.23848 92.1172 8.49483 91.5581 9.88383C90.999 11.2728 90.7374 12.7636 90.7901 14.26C90.7901 19.125 90.7901 23.99 90.7901 28.855V30.5093H88.6776V1.24287H90.7606V7.24023C93.3158 2.86589 97.2596 1.24287 102.209 1.12483L102.195 1.11268ZM0.578042 14.9109L1.50846 10.3162C4.06363 1.23072 14.4787 -2.54996 21.6443 3.07767C25.8399 6.37231 26.8866 11.04 26.6817 16.2996H3.04468C2.6628 25.694 9.44129 31.3668 18.1119 28.4714C20.9691 27.4299 23.1198 25.0552 23.828 22.1043C24.2863 20.6288 25.0431 20.3754 26.4283 20.8024C26.1973 22.601 25.5615 24.3238 24.5687 25.8412C23.5759 27.3586 22.252 28.6312 20.6965 29.5632C18.1267 30.9687 15.1783 31.5255 12.2729 31.1542C9.36751 30.7829 6.65392 29.5024 4.52015 27.4959C2.40936 25.1229 1.13525 22.1234 0.887023 18.9555C0.887023 18.4347 0.713438 17.9487 0.591929 17.48C0.580356 16.604 0.57457 15.7476 0.57457 14.9109H0.578042ZM3.07419 14.2756H24.4494C24.3158 7.46589 20.0178 2.63502 14.286 2.58989C7.90506 2.5031 3.33978 7.22808 3.05857 14.2461L3.07419 14.2756Z"
13+
fill="white"
14+
/>
15+
</g>
16+
<defs>
17+
<clipPath id="clip0_5334_22417">
18+
<rect width="184" height="41.6604" fill="white" />
19+
</clipPath>
20+
</defs>
21+
</svg>
22+
}
23+
href="/documentation/quickstarts/express"
24+
/>

0 commit comments

Comments
 (0)