Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] docs changes for manual tick #26444

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 32 additions & 3 deletions docs/content/concepts/automation/schedules/testing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Using the UI, you can manually trigger test evaluations of a schedule and view t

2. Click the schedule you want to test.

3. Click the **Test Schedule** button, located near the top right corner of the page.
3. Click the **Preview tick result** button, located near the top right corner of the page.

4. You'll be prompted to select a mock schedule evaluation time. As schedules are defined on a cadence, the evaluation times in the dropdown are past and future times along that cadence.

Expand All @@ -32,9 +32,38 @@ Using the UI, you can manually trigger test evaluations of a schedule and view t
height={1388}
/>

5. After selecting an evaluation time, click the **Evaluate** button.
5. After selecting an evaluation time, click the **Continue** button.

A window containing the evaluation result will display after the test completes. If the evaluation was successful, click **Open in Launchpad** to launch a run with the same config as the test evaluation.
6. A window containing the evaluation result will display after the test completes.

<!-- ![Results page after evaluating the schedule in the Dagster UI](/images/concepts/partitions-schedules-sensors/schedules/testing-result-page.png) -->

<Image
alt="Results page after evaluating the schedule in the Dagster UI"
src="/images/concepts/automation/schedules/testing-result-page.png"
width={2638}
height={1388}
/>

If the preview was successful, then for each produced run request, you can view the run config and tags produced by that run request by clicking the **{}** button in the Actions column. <!-- ![Actions page in the Dagster UI](/images/concepts/partitions-schedules-sensors/schedules/testing-actions-page.png) -->

<Image
alt="Actions page in the Dagster UI"
src="/images/concepts/automation/schedules/testing-actions-page.png"
width={2638}
height={1388}
/>

7. Click the **Launch all & commit tick result** on the bottom right to launch all the run requests. It will launch the runs and link to the /runs page filtered to the IDs of the runs that launched.

<!-- ![Runs page after launching all runs in the Dagster UI](/images/concepts/partitions-schedules-sensors/schedules/testing-launched-runs-page.png) -->

<Image
alt="Runs page after launching all runs"
src="/images/concepts/automation/schedules/testing-launched-runs-page.png"
width={2638}
height={1388}
/>

---

Expand Down
28 changes: 24 additions & 4 deletions docs/content/concepts/partitions-schedules-sensors/sensors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -319,31 +319,51 @@ In the UI, you can manually trigger a test evaluation of a sensor and view the r

2. Click the sensor you want to test.

3. Click the **Test Sensor** button, located near the top right corner of the page.
3. Click the **Preview tick result** button, located near the top right corner of the page.

<Image
src="/images/concepts/partitions-schedules-sensors/sensors/test-sensor-button.png"
width={592}
height={270}
/>

4. You'll be prompted to provide a cursor value. You can use the existing cursor for the sensor (which will be prepopulated) or enter a different value. If you're not using cursors, leave this field blank.
4. You'll be prompted to provide a cursor value (optional). You can use the existing cursor for the sensor (which will be prepopulated) or enter a different value. If you're not using cursors, leave this field blank.

<Image
src="/images/concepts/partitions-schedules-sensors/sensors/provide-cursor-page.png"
width={900}
height={454}
/>

5. Click **Evaluate** to fire the sensor. A window containing the result of the evaluation will display, whether it's run requests, a skip reason, or a Python error:
5. Click **Continue** to fire the sensor. A window containing the result of the evaluation will display, whether it's run requests, a skip reason, or a Python error:

<Image
src="/images/concepts/partitions-schedules-sensors/sensors/eval-result-page.png"
width={898}
height={455}
/>

If the run was successful, then for each produced run request, you can open the launchpad pre-scaffolded with the config produced by that run request. You'll also see a new computed cursor value from the evaluation, with the option to persist the value.
6. If the preview was successful, then for each produced run request, you can view the run config and tags produced by that run request by clicking the **{}** button in the Actions column.

<!-- ![Actions page in the Dagster UI](/images/concepts/partitions-schedules-sensors/sensors/actions-page.png) -->

<Image
alt="Actions page in the Dagster UI"
src="/images/concepts/partitions-schedules-sensors/sensors/actions-page.png"
width={2638}
height={1388}
/>

7. Click the **Launch all & commit tick result** on the bottom right to launch all the run requests. It will launch the runs and link to the /runs page filtered to the IDs of the runs that launched.

<!-- ![Runs page after launching all runs in the Dagster UI](/images/concepts/partitions-schedules-sensors/sensors/launch-all-page.png) -->

<Image
alt="Runs page after launching all runs"
src="/images/concepts/partitions-schedules-sensors/sensors/launch-all-page.png"
width={2638}
height={1388}
/>

</TabItem>
<TabItem name="Via the CLI">
Expand Down
4 changes: 2 additions & 2 deletions docs/content/concepts/webserver/ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ height={1942}

### Schedule details

- **Description**: The **Schedule details** page contains details about a single schedule, including its next tick, tick history, and run history. Clicking the **Test schedule** button near the top right corner of the page allows you to test the schedule.
- **Description**: The **Schedule details** page contains details about a single schedule, including its next tick, tick history, and run history. Clicking the **Preview tick result** button near the top right corner of the page allows you to test the schedule.

- **Accessed by**: Clicking a schedule in the [**Schedules** page](#all-schedules)

Expand Down Expand Up @@ -340,7 +340,7 @@ height={1938}

### Sensor details

- **Description**: The **Sensor details** page contains details about a single sensor, including its next tick, tick history, and run history. Clicking the **Test sensor** button near the top right corner of the page allows you to test the sensor.
- **Description**: The **Sensor details** page contains details about a single sensor, including its next tick, tick history, and run history. Clicking the **Preview tick result** button near the top right corner of the page allows you to test the sensor.

- **Accessed by**: Clicking a sensor in the [**Sensors** page](#all-sensors)

Expand Down
2 changes: 1 addition & 1 deletion docs/content/tutorial/scheduling-your-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ width={1152}
height={637}
/>

To test the change, click the schedule's name to view its details. Click the **Test Schedule** button on the top right corner of the page to trigger the schedule immediately.
To test the change, click the schedule's name to view its details. Click the **Preview tick result** button on the top right corner of the page to trigger the schedule immediately.

<Image
alt="how to test a schedule in the Dagster UI"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,9 @@ To ensure the jobs and schedules are visible, **reload the definitions** before
---

- {% width="60%" %}
To test a schedule, use the **Test Schedule** button in the upper-right corner of the page. This can be handy when a schedule doesn’t run very often or you want to make sure a schedule is working correctly.
To test a schedule, use the **Preview tick result** button in the upper-right corner of the page. This can be handy when a schedule doesn’t run very often or you want to make sure a schedule is working correctly.

- ![The Test Schedule button highlighted in the Schedule details page](/images/dagster-essentials/lesson-7/ui-test-schedule.png) {% rowspan=2 %}
- ![The Preview tick result button highlighted in the Schedule details page](/images/dagster-essentials/lesson-7/ui-test-schedule.png) {% rowspan=2 %}

{% /table %}

Expand All @@ -128,7 +128,7 @@ To ensure the jobs and schedules are visible, **reload the definitions** before
- {% width="60%" %}
After the button is clicked, you’ll be prompted to select a mock evaluation time.

Click **Evaluate** to run the test.
Click **Continue** to run the test.

- ![Mock evaluation time selection](/images/dagster-essentials/lesson-7/ui-mock-evaluation-time.png) {% rowspan=2 %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ As sensors are turned off by default, you'll need to enable the sensor to be abl

1. If you navigated away from the **Sensor details** page for the `adhoc_request_sensor`, navigate back to it before continuing.

2. On this page, click the **Test Sensor** button near the top-right of the page. This allows you to produce a single tick without turning the sensor on.
2. On this page, click the **Preview tick result** button near the top-right of the page. This allows you to produce a single tick without turning the sensor on.

3. Click **Evaluate** to begin the test.

- ![The Test Sensor dialog in the Dagster UI](/images/dagster-essentials/lesson-9/ui-test-sensor-dialog.png) {% rowspan=2 %}
3. Click **Continue** to begin the test.
- ![The Preview tick result dialog in the Dagster UI](/images/dagster-essentials/lesson-9/ui-test-sensor-dialog.png) {% rowspan=2 %}

{% /table %}

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
workspace: python_modules/dagster-test/dagster_test/toys/workspace.yaml
steps:
- navigate to the page for math_schedule
- take a screenshot of the top right corner of the page, making sure to include the "Test schedule" button
- take a screenshot of the top right corner of the page, making sure to include the "Preview tick result" button
vetted: false
- id: select-timestamp-page.png
workspace: python_modules/dagster-test/dagster_test/toys/workspace.yaml
steps:
- navigate to the page for math_schedule
- click the test schedule button, screenshot the window that pops up
- click the Preview tick result button, screenshot the window that pops up
vetted: false
- id: eval-schedule-result-page.png
workspace: python_modules/dagster-test/dagster_test/toys/workspace.yaml
steps:
- navigate to the page for math_schedule
- click the test schedule button, then the evaluate button
- click the Preview tick result button, then the evaluate button
- screenshot the window that pops up
vetted: false
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@
workspace: python_modules/dagster-test/dagster_test/toys/workspace.yaml
steps:
- navigate to the page for math_sensor
- take a screenshot of the top right corner of the page, making sure to include the "Test sensor" button
- take a screenshot of the top right corner of the page, making sure to include the "Preview tick result" button
vetted: false
- id: provide-cursor-page.png
workspace: python_modules/dagster-test/dagster_test/toys/workspace.yaml
steps:
- navigate to the page for math_sensor
- change the cursor value to 0
- click the test sensor button, screenshot the window that pops up
- click the Preview tick result button, screenshot the window that pops up
vetted: false
- id: eval-result-page.png
workspace: python_modules/dagster-test/dagster_test/toys/workspace.yaml
steps:
- navigate to the page for math_sensor
- change the cursor value to 0
- click the test sensor button, then the evaluate button
- click the Preview tick result button, then the evaluate button
- screenshot the window that pops up
vetted: false
Loading