Skip to content

Commit

Permalink
[docs] - Add examples page for Schedules (DOC-191) (#21735)
Browse files Browse the repository at this point in the history
## Summary & Motivation

This PR experiments with adding an **Examples** page for Schedules. It
pulls some examples from the current Schedules concept page and
simplifies the explanations to make it easier to skim. The focus of this
reference is not to teach users how to do X, but to quickly demonstrate,
provide relevant links to jump to, and let them get back to work.

I've added a summary table to each example that contains:

- Any notes, tips, etc. about the example
- Links to related documentation. For example, where the code is used
and has a more learning-focused explanation
- A list of APIs used in each example

![Screenshot 2024-05-08 at 5 27 36
PM](https://github.com/dagster-io/dagster/assets/16615212/a9c04055-5a0b-4a3d-b294-b011c7fa337b)

## How I Tested These Changes

👀
  • Loading branch information
erinkcochran87 committed May 10, 2024
1 parent 504caee commit aa6786b
Show file tree
Hide file tree
Showing 2 changed files with 757 additions and 6 deletions.
Expand Up @@ -180,12 +180,12 @@ dagster schedule stop

You can set the schedule's default status using `DefaultScheduleStatus.RUNNING` in the schedule's <PyObject object="ScheduleDefinition" />:

```python file=concepts/partitions_schedules_sensors/schedules/basic_asset_schedule.py lines=43-47
# start_definitions
defs = Definitions(
assets=[orders_asset, users_asset],
jobs=[ecommerce_job],
schedules=[ecommerce_schedule],
```python file=concepts/partitions_schedules_sensors/schedules/basic_asset_schedule.py startafter=start_schedule endbefore=end_schedule
ecommerce_schedule = ScheduleDefinition(
job=ecommerce_job,
cron_schedule="15 5 * * 1-5",
default_status=DefaultScheduleStatus.RUNNING,
)
```

</TabItem>
Expand Down

0 comments on commit aa6786b

Please sign in to comment.