Skip to content

Commit

Permalink
fix code examples links
Browse files Browse the repository at this point in the history
Signed-off-by: nikki everett <[email protected]>
  • Loading branch information
neverett committed Dec 3, 2024
1 parent d58aef1 commit ebee003
Show file tree
Hide file tree
Showing 12 changed files with 67 additions and 67 deletions.
58 changes: 29 additions & 29 deletions docs/docs-beta/docs/dagster-plus/features/alerts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Setting up alerts on Dagster+
sidebar_label: "Dagster+ Alerts"
sidebar_position: 30
---
[comment]: <> (This file is automatically generated by `dagster-plus/features/alerts/generate_alerts_doc.py`)
[comment]: <> (This file is automatically generated by `dagster-plus/deployment/alerts/generate_alerts_doc.py`)

Dagster+ allows you to configure alerts to automatically fire in response to a range of events. These alerts can be sent to a variety of different services, depending on your organization's needs.

Expand Down Expand Up @@ -80,16 +80,16 @@ If desired, add **tags** in the format `{key}:{value}` to filter the runs that w
```
<Tabs groupId="notification_service">
<TabItem value='email' label='Email'>
<CodeExample filePath="dagster-plus/features/alerts/schedule-sensor-failure-email.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/schedule-sensor-failure-email.yaml" language="yaml" />
</TabItem>
<TabItem value='microsoft_teams' label='Microsoft Teams'>
<CodeExample filePath="dagster-plus/features/alerts/schedule-sensor-failure-microsoft_teams.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/schedule-sensor-failure-microsoft_teams.yaml" language="yaml" />
</TabItem>
<TabItem value='pagerduty' label='PagerDuty'>
<CodeExample filePath="dagster-plus/features/alerts/schedule-sensor-failure-pagerduty.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/schedule-sensor-failure-pagerduty.yaml" language="yaml" />
</TabItem>
<TabItem value='slack' label='Slack'>
<CodeExample filePath="dagster-plus/features/alerts/schedule-sensor-failure-slack.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/schedule-sensor-failure-slack.yaml" language="yaml" />
</TabItem>
</Tabs>

Expand Down Expand Up @@ -120,16 +120,16 @@ If desired, add **tags** in the format `{key}:{value}` to filter the runs that w
```
<Tabs groupId="notification_service">
<TabItem value='email' label='Email'>
<CodeExample filePath="dagster-plus/features/alerts/job-running-over-one-hour-email.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/job-running-over-one-hour-email.yaml" language="yaml" />
</TabItem>
<TabItem value='microsoft_teams' label='Microsoft Teams'>
<CodeExample filePath="dagster-plus/features/alerts/job-running-over-one-hour-microsoft_teams.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/job-running-over-one-hour-microsoft_teams.yaml" language="yaml" />
</TabItem>
<TabItem value='pagerduty' label='PagerDuty'>
<CodeExample filePath="dagster-plus/features/alerts/job-running-over-one-hour-pagerduty.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/job-running-over-one-hour-pagerduty.yaml" language="yaml" />
</TabItem>
<TabItem value='slack' label='Slack'>
<CodeExample filePath="dagster-plus/features/alerts/job-running-over-one-hour-slack.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/job-running-over-one-hour-slack.yaml" language="yaml" />
</TabItem>
</Tabs>

Expand Down Expand Up @@ -160,16 +160,16 @@ If desired, select a **target** from the dropdown menu to scope this alert to a
```
<Tabs groupId="notification_service">
<TabItem value='email' label='Email'>
<CodeExample filePath="dagster-plus/features/alerts/schedule-sensor-failure-email.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/schedule-sensor-failure-email.yaml" language="yaml" />
</TabItem>
<TabItem value='microsoft_teams' label='Microsoft Teams'>
<CodeExample filePath="dagster-plus/features/alerts/schedule-sensor-failure-microsoft_teams.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/schedule-sensor-failure-microsoft_teams.yaml" language="yaml" />
</TabItem>
<TabItem value='pagerduty' label='PagerDuty'>
<CodeExample filePath="dagster-plus/features/alerts/schedule-sensor-failure-pagerduty.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/schedule-sensor-failure-pagerduty.yaml" language="yaml" />
</TabItem>
<TabItem value='slack' label='Slack'>
<CodeExample filePath="dagster-plus/features/alerts/schedule-sensor-failure-slack.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/schedule-sensor-failure-slack.yaml" language="yaml" />
</TabItem>
</Tabs>

Expand Down Expand Up @@ -200,16 +200,16 @@ If desired, select a **target** from the dropdown menu to scope this alert to a
```
<Tabs groupId="notification_service">
<TabItem value='email' label='Email'>
<CodeExample filePath="dagster-plus/features/alerts/asset-check-failed-email.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/asset-check-failed-email.yaml" language="yaml" />
</TabItem>
<TabItem value='microsoft_teams' label='Microsoft Teams'>
<CodeExample filePath="dagster-plus/features/alerts/asset-check-failed-microsoft_teams.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/asset-check-failed-microsoft_teams.yaml" language="yaml" />
</TabItem>
<TabItem value='pagerduty' label='PagerDuty'>
<CodeExample filePath="dagster-plus/features/alerts/asset-check-failed-pagerduty.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/asset-check-failed-pagerduty.yaml" language="yaml" />
</TabItem>
<TabItem value='slack' label='Slack'>
<CodeExample filePath="dagster-plus/features/alerts/asset-check-failed-slack.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/asset-check-failed-slack.yaml" language="yaml" />
</TabItem>
</Tabs>

Expand All @@ -235,16 +235,16 @@ Alerts are sent only when a schedule/sensor transitions from **success** to **fa
```
<Tabs groupId="notification_service">
<TabItem value='email' label='Email'>
<CodeExample filePath="dagster-plus/features/alerts/schedule-sensor-failure-email.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/schedule-sensor-failure-email.yaml" language="yaml" />
</TabItem>
<TabItem value='microsoft_teams' label='Microsoft Teams'>
<CodeExample filePath="dagster-plus/features/alerts/schedule-sensor-failure-microsoft_teams.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/schedule-sensor-failure-microsoft_teams.yaml" language="yaml" />
</TabItem>
<TabItem value='pagerduty' label='PagerDuty'>
<CodeExample filePath="dagster-plus/features/alerts/schedule-sensor-failure-pagerduty.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/schedule-sensor-failure-pagerduty.yaml" language="yaml" />
</TabItem>
<TabItem value='slack' label='Slack'>
<CodeExample filePath="dagster-plus/features/alerts/schedule-sensor-failure-slack.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/schedule-sensor-failure-slack.yaml" language="yaml" />
</TabItem>
</Tabs>

Expand All @@ -268,16 +268,16 @@ You can set up alerts to fire when any code location fails to load due to an err
```
<Tabs groupId="notification_service">
<TabItem value='email' label='Email'>
<CodeExample filePath="dagster-plus/features/alerts/code-location-error-email.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/code-location-error-email.yaml" language="yaml" />
</TabItem>
<TabItem value='microsoft_teams' label='Microsoft Teams'>
<CodeExample filePath="dagster-plus/features/alerts/code-location-error-microsoft_teams.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/code-location-error-microsoft_teams.yaml" language="yaml" />
</TabItem>
<TabItem value='pagerduty' label='PagerDuty'>
<CodeExample filePath="dagster-plus/features/alerts/code-location-error-pagerduty.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/code-location-error-pagerduty.yaml" language="yaml" />
</TabItem>
<TabItem value='slack' label='Slack'>
<CodeExample filePath="dagster-plus/features/alerts/code-location-error-slack.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/code-location-error-slack.yaml" language="yaml" />
</TabItem>
</Tabs>

Expand Down Expand Up @@ -305,16 +305,16 @@ You can set up alerts to fire if your Hybrid agent hasn't sent a heartbeat in th
```
<Tabs groupId="notification_service">
<TabItem value='email' label='Email'>
<CodeExample filePath="dagster-plus/features/alerts/code-location-error-email.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/code-location-error-email.yaml" language="yaml" />
</TabItem>
<TabItem value='microsoft_teams' label='Microsoft Teams'>
<CodeExample filePath="dagster-plus/features/alerts/code-location-error-microsoft_teams.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/code-location-error-microsoft_teams.yaml" language="yaml" />
</TabItem>
<TabItem value='pagerduty' label='PagerDuty'>
<CodeExample filePath="dagster-plus/features/alerts/code-location-error-pagerduty.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/code-location-error-pagerduty.yaml" language="yaml" />
</TabItem>
<TabItem value='slack' label='Slack'>
<CodeExample filePath="dagster-plus/features/alerts/code-location-error-slack.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/alerts/code-location-error-slack.yaml" language="yaml" />
</TabItem>
</Tabs>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ The **Filter** button near the top left of the page can be used to filter the li
Audit logs can be accessed programmatically over the Dagster+ GraphQL API. You can access a visual GraphiQL interface
by navigating to `https://<org>.dagster.cloud/<deployment>/graphql` in your browser. You can also query the API directly using the Python client.

<CodeExample filePath="dagster-plus/features/authentication-and-access-control/rbac/audit-logs.graphql" language="graphql" title="Audit log GraphQL query" />
<CodeExample filePath="dagster-plus/access/rbac/audit-logs.graphql" language="graphql" title="Audit log GraphQL query" />
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ While you can use your existing production agent, we recommend creating a dedica

For example:

<CodeExample filePath="dagster-plus/features/branch-deployments/dagster.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/branch-deployments/dagster.yaml" language="yaml" />

</TabItem>
<TabItem value="k8s" label="Kubernetes" default>
Expand All @@ -125,7 +125,7 @@ While you can use your existing production agent, we recommend creating a dedica

2. After the agent is set up, modify your Helm values file to include the following:

<CodeExample filePath="dagster-plus/features/branch-deployments/helm.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/branch-deployments/helm.yaml" language="yaml" />

</TabItem>
</Tabs>
Expand Down Expand Up @@ -158,7 +158,7 @@ In the `dagster_cloud.yaml` file, replace `build.registry` with the registry use

For example:

<CodeExample filePath="dagster-plus/features/branch-deployments/dagster_cloud.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/branch-deployments/dagster_cloud.yaml" language="yaml" />

### Step 4.3: Configure GitHub Action secrets

Expand Down Expand Up @@ -267,7 +267,7 @@ In the `dagster_cloud.yaml` file, replace `build.registry` with the registry use

For example:

<CodeExample filePath="dagster-plus/features/branch-deployments/dagster_cloud.yaml" language="yaml" />
<CodeExample filePath="dagster-plus/deployment/branch-deployments/dagster_cloud.yaml" language="yaml" />

### Step 4.3: configure GitLab CI/CD variables

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ To enable this behavior, replace usage of `BigQueryResource` with `InsightsBigQu

<Tabs>
<TabItem value="before" label="Before">
<CodeExample filePath="dagster-plus/features/insights/google-bigquery/bigquery-resource.py" language="python" />
<CodeExample filePath="dagster-plus/insights/google-bigquery/bigquery-resource.py" language="python" />
</TabItem>
<TabItem value="after" label="After" default>
<CodeExample filePath="dagster-plus/features/insights/google-bigquery/bigquery-resource-insights.py" language="python" />
<CodeExample filePath="dagster-plus/insights/google-bigquery/bigquery-resource-insights.py" language="python" />
</TabItem>
</Tabs>

Expand All @@ -55,21 +55,21 @@ First, add a `.with_insights()` call to your `dbt.cli()` command(s).

<Tabs>
<TabItem value="before" label="Before">
<CodeExample filePath="dagster-plus/features/insights/google-bigquery/bigquery-dbt-asset.py" language="python" />
<CodeExample filePath="dagster-plus/insights/google-bigquery/bigquery-dbt-asset.py" language="python" />
</TabItem>
<TabItem value="after" label="After" default>
<CodeExample filePath="dagster-plus/features/insights/google-bigquery/bigquery-dbt-asset-insights.py" language="python" />
<CodeExample filePath="dagster-plus/insights/google-bigquery/bigquery-dbt-asset-insights.py" language="python" />
</TabItem>
</Tabs>

Then, add the following to your `dbt_project.yml`:

<Tabs>
<TabItem value="before" label="Before">
<CodeExample filePath="dagster-plus/features/insights/google-bigquery/dbt_project.yml" language="python" />
<CodeExample filePath="dagster-plus/insights/google-bigquery/dbt_project.yml" language="python" />
</TabItem>
<TabItem value="after" label="After" default>
<CodeExample filePath="dagster-plus/features/insights/google-bigquery/dbt_project_insights.yml" language="python" />
<CodeExample filePath="dagster-plus/insights/google-bigquery/dbt_project_insights.yml" language="python" />
</TabItem>
</Tabs>

Expand Down
12 changes: 6 additions & 6 deletions docs/docs-beta/docs/dagster-plus/features/insights/snowflake.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ Only use `create_snowflake_insights_asset_and_schedule` in a single code locatio

<Tabs>
<TabItem value="before" label="Before">
<CodeExample filePath="dagster-plus/features/insights/snowflake/snowflake-resource.py" language="python" />
<CodeExample filePath="dagster-plus/insights/snowflake/snowflake-resource.py" language="python" />
</TabItem>
<TabItem value="after" label="After" default>
<CodeExample filePath="dagster-plus/features/insights/snowflake/snowflake-resource-insights.py" language="python" />
<CodeExample filePath="dagster-plus/insights/snowflake/snowflake-resource-insights.py" language="python" />
</TabItem>
</Tabs>

Expand All @@ -63,21 +63,21 @@ Only use `create_snowflake_insights_asset_and_schedule` in a single code locatio

<Tabs>
<TabItem value="before" label="Before">
<CodeExample filePath="dagster-plus/features/insights/snowflake/snowflake-dbt-asset.py" language="python" />
<CodeExample filePath="dagster-plus/insights/snowflake/snowflake-dbt-asset.py" language="python" />
</TabItem>
<TabItem value="after" label="After" default>
<CodeExample filePath="dagster-plus/features/insights/snowflake/snowflake-dbt-asset-insights.py" language="python" />
<CodeExample filePath="dagster-plus/insights/snowflake/snowflake-dbt-asset-insights.py" language="python" />
</TabItem>
</Tabs>

Then, add the following to your `dbt_project.yml`:

<Tabs>
<TabItem value="before" label="Before">
<CodeExample filePath="dagster-plus/features/insights/snowflake/dbt_project.yml" language="python" />
<CodeExample filePath="dagster-plus/insights/snowflake/dbt_project.yml" language="python" />
</TabItem>
<TabItem value="after" label="After" default>
<CodeExample filePath="dagster-plus/features/insights/snowflake/dbt_project_insights.yml" language="python" />
<CodeExample filePath="dagster-plus/insights/snowflake/dbt_project_insights.yml" language="python" />
This adds a comment to each query, which is used by Dagster+ to attribute cost metrics to the correct assets.
</TabItem>

Expand Down
8 changes: 4 additions & 4 deletions docs/docs-beta/docs/guides/automate/asset-sensors.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ end

This is an example of an asset sensor that triggers a job when an asset is materialized. The `daily_sales_data` asset is in the same code location as the job and other asset for this example, but the same pattern can be applied to assets in different code locations.

<CodeExample filePath="guides/automate/simple-asset-sensor-example.py" language="python" />
<CodeExample filePath="guides/automation/simple-asset-sensor-example.py" language="python" />

## Customize evaluation logic

Expand Down Expand Up @@ -81,23 +81,23 @@ stateDiagram-v2

In the following example, the `@asset_sensor` decorator defines a custom evaluation function that returns a `RunRequest` object when the asset is materialized and certain metadata is present, otherwise it skips the run.

<CodeExample filePath="guides/automate/asset-sensor-custom-eval.py" language="python"/>
<CodeExample filePath="guides/automation/asset-sensor-custom-eval.py" language="python"/>

## Trigger a job with configuration

By providing a configuration to the `RunRequest` object, you can trigger a job with a specific configuration. This is useful when you want to trigger a job with custom parameters based on custom logic you define.

For example, you might use a sensor to trigger a job when an asset is materialized, but also pass metadata about that materialization to the job:

<CodeExample filePath="guides/automate/asset-sensor-with-config.py" language="python" />
<CodeExample filePath="guides/automation/asset-sensor-with-config.py" language="python" />

## Monitor multiple assets

When building a pipeline, you may want to monitor multiple assets with a single sensor. This can be accomplished with a multi-asset sensor.

The following example uses a `@multi_asset_sensor` to monitor multiple assets and trigger a job when any of the assets are materialized:

<CodeExample filePath="guides/automate/multi-asset-sensor.py" language="python" />
<CodeExample filePath="guides/automation/multi-asset-sensor.py" language="python" />

## Next steps

Expand Down
6 changes: 3 additions & 3 deletions docs/docs-beta/docs/guides/automate/schedules.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To follow the steps in this guide, you'll need:

A basic schedule is defined by a `JobDefinition` and a `cron_schedule` using the `ScheduleDefinition` class. A job can be thought of as a selection of assets or operations executed together.

<CodeExample filePath="guides/automate/simple-schedule-example.py" language="python" />
<CodeExample filePath="guides/automation/simple-schedule-example.py" language="python" />

## Run schedules in a different timezone

Expand All @@ -43,14 +43,14 @@ If using partitions and jobs, you can create a schedule using the partition with

If you have a [partitioned asset](/guides/build/create-a-pipeline/partitioning) and job:

<CodeExample filePath="guides/automate/schedule-with-partition.py" language="python" />
<CodeExample filePath="guides/automation/schedule-with-partition.py" language="python" />

</TabItem>
<TabItem value="ops" label="Ops">

If you have a partitioned op job:

<CodeExample filePath="guides/automate/schedule-with-partition-ops.py" language="python" />
<CodeExample filePath="guides/automation/schedule-with-partition-ops.py" language="python" />

</TabItem>
</Tabs>
Expand Down
Loading

0 comments on commit ebee003

Please sign in to comment.