From 893fe073dcd1838a4ec3cf6f948f05a9579d0699 Mon Sep 17 00:00:00 2001 From: Pedram Navid <1045990+PedramNavid@users.noreply.github.com> Date: Wed, 14 Aug 2024 15:28:00 -0700 Subject: [PATCH] move code blocks out --- docs/docs-next/docs/concepts/sensors.md | 0 docs/docs-next/docs/guides/automation.md | 26 +++---------------- .../docs/guides/automation/asset-sensors.md | 5 ++++ .../docs/guides/automation/schedules.md | 7 +++++ .../docs/guides/automation/sensors.md | 14 ++++++++++ 5 files changed, 30 insertions(+), 22 deletions(-) create mode 100644 docs/docs-next/docs/concepts/sensors.md create mode 100644 docs/docs-next/docs/guides/automation/asset-sensors.md create mode 100644 docs/docs-next/docs/guides/automation/sensors.md diff --git a/docs/docs-next/docs/concepts/sensors.md b/docs/docs-next/docs/concepts/sensors.md new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/docs/docs-next/docs/guides/automation.md b/docs/docs-next/docs/guides/automation.md index 7a1a776fd30bd..329160a7bca13 100644 --- a/docs/docs-next/docs/guides/automation.md +++ b/docs/docs-next/docs/guides/automation.md @@ -52,11 +52,7 @@ To make creating cron expressions easier, you can use an online tool like [Cront - You need to run jobs at regular intervals - You want basic time-based automation -### Basic Schedule Example - - - -For more examples of schedules, see the [How-To Use Schedules](/guides/automation/schedules) guide. +For examples of how to create schedules, see the [How-To Use Schedules](/guides/automation/schedules) guide. For more information about how Schedules work, see the [About Schedules](/concepts/schedules) concept page. @@ -75,20 +71,9 @@ You must provide a function that the sensor will use to determine if it should t - You need event-driven automation - You want to react to changes in external systems -### Basic Sensor Example - -This example includes a `check_for_new_files` function that simulates finding new files. In a real scenario, this function would check an actual system or directory. - -The sensor runs every 5 seconds. If it finds new files, it starts a run of `my_job`. If not, it skips the run and logs "No new files found" in the Dagster UI. +For more examples of how to create sensors, see the [How-To Use Sensors](/guides/automation/sensors) guide. - - -:::tip - -By default, sensors aren't enabled when first deployed to a Dagster instance. -Click "Automation" in the top navigation to find and enable a sensor. - -::: +For more information about how Sensors work, see the [About Sensors](/concepts/sensors) concept page. ## Asset Sensors @@ -99,11 +84,8 @@ Asset Sensors trigger jobs when specified assets are materialized, allowing you - You need to trigger jobs based on asset materializations - You want to create dependencies between different jobs or code locations -### Basic Asset Sensor Example - - +For more examples of how to create asset sensors, see the [How-To Use Asset Sensors](/guides/automation/asset-sensors) guide. -This Asset Sensor will trigger a run of `my_job` whenever the `asset_to_watch` asset is materialized. ## Choosing the Right Automation Method diff --git a/docs/docs-next/docs/guides/automation/asset-sensors.md b/docs/docs-next/docs/guides/automation/asset-sensors.md new file mode 100644 index 0000000000000..63a0b1419acae --- /dev/null +++ b/docs/docs-next/docs/guides/automation/asset-sensors.md @@ -0,0 +1,5 @@ +### Basic Asset Sensor Example + + + +This Asset Sensor will trigger a run of `my_job` whenever the `asset_to_watch` asset is materialized. \ No newline at end of file diff --git a/docs/docs-next/docs/guides/automation/schedules.md b/docs/docs-next/docs/guides/automation/schedules.md index e69de29bb2d1d..6eb7464b4fd6b 100644 --- a/docs/docs-next/docs/guides/automation/schedules.md +++ b/docs/docs-next/docs/guides/automation/schedules.md @@ -0,0 +1,7 @@ +### Basic Schedule Example + + + +For more examples of schedules, see the [How-To Use Schedules](/guides/automation/schedules) guide. + +For more information about how Schedules work, see the [About Schedules](/concepts/schedules) concept page. \ No newline at end of file diff --git a/docs/docs-next/docs/guides/automation/sensors.md b/docs/docs-next/docs/guides/automation/sensors.md new file mode 100644 index 0000000000000..976b44d698bb5 --- /dev/null +++ b/docs/docs-next/docs/guides/automation/sensors.md @@ -0,0 +1,14 @@ +### Basic Sensor Example + +This example includes a `check_for_new_files` function that simulates finding new files. In a real scenario, this function would check an actual system or directory. + +The sensor runs every 5 seconds. If it finds new files, it starts a run of `my_job`. If not, it skips the run and logs "No new files found" in the Dagster UI. + + + +:::tip + +By default, sensors aren't enabled when first deployed to a Dagster instance. +Click "Automation" in the top navigation to find and enable a sensor. + +::: \ No newline at end of file