From aded2982481a56fcfd8cd63ffc72e5ee839869d7 Mon Sep 17 00:00:00 2001 From: nicktrn <55853254+nicktrn@users.noreply.github.com> Date: Mon, 23 Sep 2024 13:40:46 +0100 Subject: [PATCH] fix broken links --- docs/config/config-file.mdx | 4 ++-- docs/errors-retrying.mdx | 4 ++-- docs/examples/ffmpeg-video-processing.mdx | 2 +- docs/guides/dashboard/creating-a-project.mdx | 2 +- docs/how-it-works.mdx | 2 +- docs/introduction.mdx | 6 +++--- docs/migration-defer.mdx | 4 ++-- docs/mint.json | 4 ++++ docs/quick-start.mdx | 2 +- docs/snippets/useful-next-steps.mdx | 2 +- docs/tasks-regular.mdx | 2 +- docs/tasks/scheduled.mdx | 2 +- docs/triggering.mdx | 4 ++-- docs/writing-tasks-introduction.mdx | 2 +- 14 files changed, 23 insertions(+), 19 deletions(-) diff --git a/docs/config/config-file.mdx b/docs/config/config-file.mdx index 661331410..44866a808 100644 --- a/docs/config/config-file.mdx +++ b/docs/config/config-file.mdx @@ -70,7 +70,7 @@ export default defineConfig({ }); ``` -Read more about task lifecycle functions in the [tasks overview](/tasks-overview). +Read more about task lifecycle functions in the [tasks overview](/tasks/overview). ## Instrumentations @@ -116,7 +116,7 @@ export default defineConfig({ }); ``` -See our [Bun guide](/guides/bun) for more information. +See our [Bun guide](/guides/frameworks/bun) for more information. ## Default machine diff --git a/docs/errors-retrying.mdx b/docs/errors-retrying.mdx index ea40d7bd5..2a9fd3863 100644 --- a/docs/errors-retrying.mdx +++ b/docs/errors-retrying.mdx @@ -9,12 +9,12 @@ When an uncaught error is thrown inside your task, that task attempt will fail. You can configure retrying in two ways: -1. In your [trigger.config file](/trigger-config) you can set the default retrying behavior for all tasks. +1. In your [trigger.config file](/config/config-file) you can set the default retrying behavior for all tasks. 2. On each task you can set the retrying behavior. By default when you create your project using the CLI init command we disabled retrying in the DEV - environment. You can enable it in your [trigger.config file](/trigger-config). + environment. You can enable it in your [trigger.config file](/config/config-file). ## A simple example with OpenAI diff --git a/docs/examples/ffmpeg-video-processing.mdx b/docs/examples/ffmpeg-video-processing.mdx index a5a33a010..31ca6a894 100644 --- a/docs/examples/ffmpeg-video-processing.mdx +++ b/docs/examples/ffmpeg-video-processing.mdx @@ -22,7 +22,7 @@ export default defineConfig({ ``` - [Build extensions](../guides/build-extensions) allow you to hook into the build system and + [Build extensions](/config/config-file#extensions) allow you to hook into the build system and customize the build process or the resulting bundle and container image (in the case of deploying). You can use pre-built extensions or create your own. diff --git a/docs/guides/dashboard/creating-a-project.mdx b/docs/guides/dashboard/creating-a-project.mdx index 73f04f63e..2854ccbd3 100644 --- a/docs/guides/dashboard/creating-a-project.mdx +++ b/docs/guides/dashboard/creating-a-project.mdx @@ -30,7 +30,7 @@ description: "This guide will show you how to create a new Trigger.dev project." Setup Trigger.dev in 3 minutes - + Learn what tasks are and how to write them diff --git a/docs/how-it-works.mdx b/docs/how-it-works.mdx index 45de378b4..a1eafc53b 100644 --- a/docs/how-it-works.mdx +++ b/docs/how-it-works.mdx @@ -424,7 +424,7 @@ When you run `npx trigger.dev@latest dev`, we run your task code locally on your Trigger.dev currently does not support "offline" dev mode, where you can run tasks without an - internet connection. [Please let us know](feedback.trigger.dev) if this is a feature you + internet connection. [Please let us know](https://feedback.trigger.dev/) if this is a feature you want/need. diff --git a/docs/introduction.mdx b/docs/introduction.mdx index 1d1325ffb..90d5d3732 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -9,8 +9,8 @@ Trigger.dev v3 makes it easy to write reliable long-running tasks without timeou - We run your tasks with no timeouts. You don't have to manage any infrastructure (unless you [self-host](/open-source-self-hosting)). Workers are automatically scaled and managed for you. - We provide a multi-tenant queue that is used when triggering tasks. -- We provide an SDK and CLI for writing tasks in your existing codebase, inside [/trigger folders](/trigger-folder). -- We provide different types of tasks: [regular](/tasks-regular) and [scheduled](/tasks-scheduled). +- We provide an SDK and CLI for writing tasks in your existing codebase, inside [/trigger folders](/config/config-file). +- We provide different types of tasks: [regular](/tasks-regular) and [scheduled](/tasks/scheduled). - We provide a dashboard for monitoring, debugging, and managing your tasks. We're [open source](https://github.com/triggerdotdev/trigger.dev) and you can choose to use the [Trigger.dev Cloud](https://cloud.trigger.dev) or [Self-host Trigger.dev](/open-source-self-hosting) on your own infrastructure. @@ -21,7 +21,7 @@ We're [open source](https://github.com/triggerdotdev/trigger.dev) and you can ch Get started in 3 minutes. - + Tasks are the core of Trigger.dev. Learn what they are and how to write them. diff --git a/docs/migration-defer.mdx b/docs/migration-defer.mdx index 3ccc16587..b40a29624 100644 --- a/docs/migration-defer.mdx +++ b/docs/migration-defer.mdx @@ -242,7 +242,7 @@ export async function runLongRunningTask() { #### Example 2: A cron task -We call these [scheduled tasks](/tasks-scheduled) in Trigger.dev. +We call these [scheduled tasks](/tasks/scheduled) in Trigger.dev. In Defer you might have a function like this: @@ -272,6 +272,6 @@ export const sendMondayNewletter = schedules.task({ Then you need to attach a schedule to the task, either using the dashboard or in your code. You can attach unlimited schedules to a task. - + How to attach a schedule to a task diff --git a/docs/mint.json b/docs/mint.json index 1c7c35cb5..be73ca4cd 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -83,6 +83,10 @@ { "source": "/trigger-folder", "destination": "/config/config-file" + }, + { + "source": "/trigger-config", + "destination": "/config/config-file" } ], "anchors": [ diff --git a/docs/quick-start.mdx b/docs/quick-start.mdx index 75f3d83a5..d6253bc26 100644 --- a/docs/quick-start.mdx +++ b/docs/quick-start.mdx @@ -47,7 +47,7 @@ Once you've created an account, follow the steps in the app to: Learn how to trigger tasks from your code. - + Tasks are the core of Trigger.dev. Learn what they are and how to write them. diff --git a/docs/snippets/useful-next-steps.mdx b/docs/snippets/useful-next-steps.mdx index 3ad1c44ac..8fdb53af1 100644 --- a/docs/snippets/useful-next-steps.mdx +++ b/docs/snippets/useful-next-steps.mdx @@ -1,7 +1,7 @@ ## Useful next steps - + Learn what tasks are and their options diff --git a/docs/tasks-regular.mdx b/docs/tasks-regular.mdx index 91d3740c8..acc1be902 100644 --- a/docs/tasks-regular.mdx +++ b/docs/tasks-regular.mdx @@ -7,7 +7,7 @@ import OpenaiRetry from "/snippets/code/openai-retry.mdx" They are defined using the `task()` function and can be [triggered](/triggering) from your backend or inside another task. -Like all tasks they don't have timeouts, they should be placed inside a [/trigger folder](/trigger-folder), and you [can configure them](/tasks-overview#defining-a-task). +Like all tasks they don't have timeouts, they should be placed inside a [/trigger folder](/config/config-file), and you [can configure them](/tasks/overview#defining-a-task). ## Example tasks diff --git a/docs/tasks/scheduled.mdx b/docs/tasks/scheduled.mdx index c9f722173..da0d6dcb7 100644 --- a/docs/tasks/scheduled.mdx +++ b/docs/tasks/scheduled.mdx @@ -60,7 +60,7 @@ You can see from the comments that the payload has several useful properties: to do that. -Like all tasks they don't have timeouts, they should be placed inside a [/trigger folder](/trigger-folder), and you [can configure them](/tasks-overview#defining-a-task). +Like all tasks they don't have timeouts, they should be placed inside a [/trigger folder](/config/config-file), and you [can configure them](/tasks/overview#defining-a-task). ## How to attach a schedule diff --git a/docs/triggering.mdx b/docs/triggering.mdx index d69bfd5df..17c3dc32a 100644 --- a/docs/triggering.mdx +++ b/docs/triggering.mdx @@ -20,11 +20,11 @@ Trigger tasks **from inside a run**: | `yourTask.triggerAndWait()` | Inside task | Triggers a task and then waits until it's complete. You get the result data to continue with. [Read more](#task-triggerandwait) | | `yourTask.batchTriggerAndWait()` | Inside task | Triggers a task multiple times in parallel and then waits until they're all complete. You get the resulting data to continue with. [Read more](#task-batchtriggerandwait) | -Additionally, [scheduled tasks](/tasks-scheduled) get **automatically** triggered on their schedule and webhooks when receiving a webhook. +Additionally, [scheduled tasks](/tasks/scheduled) get **automatically** triggered on their schedule and webhooks when receiving a webhook. ## Scheduled tasks -You should attach one or more schedules to your `schedules.task()` to trigger it on a recurring schedule. [Read the scheduled tasks docs](/tasks-scheduled). +You should attach one or more schedules to your `schedules.task()` to trigger it on a recurring schedule. [Read the scheduled tasks docs](/tasks/scheduled). ## Authentication diff --git a/docs/writing-tasks-introduction.mdx b/docs/writing-tasks-introduction.mdx index 03cbd5fdd..f9a5d48b4 100644 --- a/docs/writing-tasks-introduction.mdx +++ b/docs/writing-tasks-introduction.mdx @@ -4,7 +4,7 @@ sidebarTitle: "Introduction" description: "Tasks are the core of Trigger.dev. They are long-running processes that are triggered by events." --- -Before digging deeper into the details of writing tasks, you should read the [fundamentals of tasks](/tasks-overview) to understand what tasks are and how they work. +Before digging deeper into the details of writing tasks, you should read the [fundamentals of tasks](/tasks/overview) to understand what tasks are and how they work. ## Writing tasks