Skip to content

Commit b838f75

Browse files
committed
Minor fixes for the docs
1 parent 71befc8 commit b838f75

File tree

6 files changed

+21
-24
lines changed

6 files changed

+21
-24
lines changed

docs/documentation/introduction.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,7 @@ Trigger.dev is an open source framework for creating long-running Jobs directly
88

99
You can use [Trigger.dev Cloud](https://cloud.trigger.dev) or [Self-host Trigger.dev](/documentation/guides/self-hosting) on your own infrastructure.
1010

11-
<Note>
12-
Trigger.dev v2 currently only supports serverless. We will be adding [support for long-running
13-
servers](https://github.com/triggerdotdev/trigger.dev/issues/244) soon.
14-
</Note>
11+
<Note>Trigger.dev v2 currently only supports serverless.</Note>
1512

1613
<CardGroup>
1714
<Card title="Quick start guides" icon="person-running-fast" href="quickstarts/introduction">

docs/v3/cli-deploy.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ You run the command like this:
88
<CodeGroup>
99

1010
```bash npm
11-
npx trigger.dev@latest deploy
11+
npx trigger.dev@v3 deploy
1212
```
1313

1414
```bash pnpm
15-
pnpm dlx trigger.dev@latest deploy
15+
pnpm dlx trigger.dev@v3 deploy
1616
```
1717

1818
```bash yarn
19-
yarn dlx trigger.dev@latest deploy
19+
yarn dlx trigger.dev@v3 deploy
2020
```
2121

2222
</CodeGroup>
@@ -49,7 +49,7 @@ The log level to use (debug, info, log, warn, error, none). Defaults to `log`.
4949

5050
### Set config filename `--config` or `-c`
5151

52-
The name of the config file, found where the command is run from. Defaults to `trigger.config.mjs`.
52+
The name of the config file, found where the command is run from. Defaults to `trigger.config.ts`.
5353

5454
### Set the projectRef `--project-ref` or `-p`
5555

docs/v3/cli-dev.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ This runs a server on your machine that can execute Trigger.dev tasks:
88
<CodeGroup>
99

1010
```bash npm
11-
npx trigger.dev@latest dev
11+
npx trigger.dev@v3 dev
1212
```
1313

1414
```bash pnpm
15-
pnpm dlx trigger.dev@latest dev
15+
pnpm dlx trigger.dev@v3 dev
1616
```
1717

1818
```bash yarn
19-
yarn dlx trigger.dev@latest dev
19+
yarn dlx trigger.dev@v3 dev
2020
```
2121

2222
</CodeGroup>
@@ -34,15 +34,15 @@ You can use the `--debugger` flag to run the server in debug mode. This will all
3434
<CodeGroup>
3535

3636
```bash npm
37-
npx trigger.dev@latest dev --debugger
37+
npx trigger.dev@v3 dev --debugger
3838
```
3939

4040
```bash pnpm
41-
pnpm dlx trigger.dev@latest dev --debugger
41+
pnpm dlx trigger.dev@v3 dev --debugger
4242
```
4343

4444
```bash yarn
45-
yarn dlx trigger.dev@latest dev --debugger
45+
yarn dlx trigger.dev@v3 dev --debugger
4646
```
4747

4848
</CodeGroup>

docs/v3/github-actions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
env:
3232
TRIGGER_ACCESS_TOKEN: ${{ secrets.TRIGGER_ACCESS_TOKEN }}
3333
run: |
34-
npx trigger.dev@latest deploy
34+
npx trigger.dev@v3 deploy
3535
```
3636
3737
If you already have a GitHub action file, you can just add the final step "🚀 Deploy Trigger.dev" to your existing file.

docs/v3/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ description: "Welcome to the Trigger.dev v3 documentation."
1212

1313
Trigger.dev v3 makes it easy to write reliable long-running tasks without timeouts.
1414

15-
- We run your tasks with no timeouts. You don't have to manage any infrastructure (unless you [self-host](/v3/self-hosting)). Workers are automatically scaled and managed for you.
15+
- We run your tasks with no timeouts. You don't have to manage any infrastructure (unless you [self-host](/v3/open-source-self-hosting)). Workers are automatically scaled and managed for you.
1616
- We provide a multi-tenant queue that is used when triggering tasks.
1717
- We provide an SDK and CLI for writing tasks in your existing codebase, inside [/trigger folders](/v3/trigger-folder).
1818
- We provide different types of tasks: [regular](/v3/tasks-regular), [scheduled](/v3/tasks-scheduled), [zod](/v3/tasks-zod), [webhooks](/v3/tasks-webhooks).

docs/v3/quick-start.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "How to get started in 3 minutes using the CLI and SDK."
55

66
In this guide we will:
77

8-
1. Create a `trigger.config.mjs` file and a `/trigger` directory with an example task.
8+
1. Create a `trigger.config.ts` file and a `/trigger` directory with an example task.
99
2. Get you to run the task using the CLI.
1010
3. Show you how to view the run logs for that task.
1111

@@ -43,23 +43,23 @@ Run this command in the root of your project to get started:
4343
<CodeGroup>
4444

4545
```bash npm
46-
npx trigger.dev@latest init
46+
npx trigger.dev@v3 init
4747
```
4848

4949
```bash pnpm
50-
pnpm dlx trigger.dev@latest init
50+
pnpm dlx trigger.dev@v3 init
5151
```
5252

5353
```bash yarn
54-
yarn dlx trigger.dev@latest init
54+
yarn dlx trigger.dev@v3 init
5555
```
5656

5757
</CodeGroup>
5858

5959
It will do a few things:
6060

6161
1. Log you into the CLI if you're not already logged in.
62-
2. Create a `trigger.config.mjs` file in the root of your project.
62+
2. Create a `trigger.config.ts` file in the root of your project.
6363
3. Ask where you'd like to create the `/trigger` directory.
6464
4. Create the `/trigger` directory with an example task, `/trigger/example.[ts/js]`.
6565

@@ -72,15 +72,15 @@ The CLI `dev` command runs a server for your tasks. It will watches for changes
7272
<CodeGroup>
7373

7474
```bash npm
75-
npx trigger.dev@latest dev
75+
npx trigger.dev@v3 dev
7676
```
7777

7878
```bash pnpm
79-
pnpm dlx trigger.dev@latest dev
79+
pnpm dlx trigger.dev@v3 dev
8080
```
8181

8282
```bash yarn
83-
yarn dlx trigger.dev@latest dev
83+
yarn dlx trigger.dev@v3 dev
8484
```
8585

8686
</CodeGroup>

0 commit comments

Comments
 (0)