Merge branch 'docs/revamp' into jb-more-theme-work

dagster-io · Aug 17, 2024 · 14752ca · 14752ca
2 parents dc8a39d + af3c47e
commit 14752ca
Show file tree

Hide file tree

Showing 16 changed files with 91 additions and 38 deletions.
diff --git a/docs/docs-next/src/templates/concept.md → docs/docs-next/content-templates/concept.md b/docs/docs-next/src/templates/concept.md → docs/docs-next/content-templates/concept.md
diff --git a/...s-next/src/templates/example-reference.md → ...xt/content-templates/example-reference.md b/...s-next/src/templates/example-reference.md → ...xt/content-templates/example-reference.md
diff --git a/...docs-next/src/templates/guide-no-steps.md → ...-next/content-templates/guide-no-steps.md b/...docs-next/src/templates/guide-no-steps.md → ...-next/content-templates/guide-no-steps.md
diff --git a/...cs-next/src/templates/guide-with-steps.md → ...ext/content-templates/guide-with-steps.md b/...cs-next/src/templates/guide-with-steps.md → ...ext/content-templates/guide-with-steps.md
diff --git a/docs/docs-next/docs/code_examples/guides/automation/asset-sensor-with-config.py b/docs/docs-next/docs/code_examples/guides/automation/asset-sensor-with-config.py
@@ -0,0 +1,52 @@
+from dagster import (
+    AssetExecutionContext,
+    AssetKey,
+    Definitions,
+    EventLogEntry,
+    RunRequest,
+    SensorEvaluationContext,
+    asset,
+    asset_sensor,
+    define_asset_job,
+)
+
+
+@asset
+def daily_sales_data(context: AssetExecutionContext):
+    context.log.info("Asset to watch")
+
+
+@asset
+def weekly_report(context: AssetExecutionContext):
+    context.log.info("Asset to trigger")
+
+
+my_job = define_asset_job("my_job", [weekly_report])
+
+
+# highlight-start
+@asset_sensor(asset_key=AssetKey("daily_sales_data"), job=my_job)
+def daily_sales_data_sensor(context: SensorEvaluationContext, asset_event: EventLogEntry):
+    # This satisifies the type checker. Asset events are guaranteed to have a dagster_event and asset_key.
+    assert asset_event.dagster_event is not None
+    assert asset_event.dagster_event.asset_key is not None
+
+    return RunRequest(
+        run_key=context.cursor,
+        run_config={
+            "ops": {
+                "read_materialization": {
+                    "config": {
+                        "asset_key": asset_event.dagster_event.asset_key.path,
+                    }
+                }
+            }
+        },
+    )  # highlight-end
+
+
+defs = Definitions(
+    assets=[daily_sales_data, weekly_report],
+    jobs=[my_job],
+    sensors=[daily_sales_data_sensor],
+)
diff --git a/docs/docs-next/docs/code_examples/guides/automation/simple-asset-sensor-example.py b/docs/docs-next/docs/code_examples/guides/automation/simple-asset-sensor-example.py
@@ -0,0 +1,36 @@
+from dagster import (
+    AssetExecutionContext,
+    AssetKey,
+    Definitions,
+    RunRequest,
+    asset,
+    asset_sensor,
+    define_asset_job,
+)
+
+
+@asset
+def daily_sales_data(context: AssetExecutionContext):
+    context.log.info("Asset to watch")
+
+
+@asset
+def weekly_report(context: AssetExecutionContext):
+    context.log.info("Asset to trigger")
+
+
+my_job = define_asset_job("my_job", [weekly_report])
+
+
+# highlight-start
+@asset_sensor(asset_key=AssetKey("daily_sales_data"), job_name="my_job")
+def daily_sales_data_sensor():
+    return RunRequest()
+    # highlight-end
+
+
+defs = Definitions(
+    assets=[daily_sales_data, weekly_report],
+    jobs=[my_job],
+    sensors=[daily_sales_data_sensor],
+)
diff --git a/...des/automation/simple-schedule-example.py → ...des/automation/simple-schedule-example.py b/...des/automation/simple-schedule-example.py → ...des/automation/simple-schedule-example.py
diff --git a/...uides/automation/simple-sensor-example.py → ...uides/automation/simple-sensor-example.py b/...uides/automation/simple-sensor-example.py → ...uides/automation/simple-sensor-example.py
diff --git a/...passing-data-assets/passing-data-avoid.py → ...passing-data-assets/passing-data-avoid.py b/...passing-data-assets/passing-data-avoid.py → ...passing-data-assets/passing-data-avoid.py
diff --git a/...sing-data-assets/passing-data-explicit.py → ...sing-data-assets/passing-data-explicit.py b/...sing-data-assets/passing-data-explicit.py → ...sing-data-assets/passing-data-explicit.py
diff --git a/...ng-data-assets/passing-data-io-manager.py → ...ng-data-assets/passing-data-io-manager.py b/...ng-data-assets/passing-data-io-manager.py → ...ng-data-assets/passing-data-io-manager.py
diff --git a/...ata-assets/passing-data-rewrite-assets.py → ...ata-assets/passing-data-rewrite-assets.py b/...ata-assets/passing-data-rewrite-assets.py → ...ata-assets/passing-data-rewrite-assets.py
diff --git a/docs/docs-next/docs/guides/automation/simple-asset-sensor-example.py b/docs/docs-next/docs/guides/automation/simple-asset-sensor-example.py
diff --git a/docs/docs-next/src/components/CodeExample.tsx b/docs/docs-next/src/components/CodeExample.tsx
@@ -13,7 +13,7 @@ const CodeExample: React.FC<CodeExampleProps> = ({filePath, language, title}) =>
 
   React.useEffect(() => {
     // Adjust the import path to start from the docs directory
-    import(`!!raw-loader!/docs/${filePath}`)
+    import(`!!raw-loader!/docs/code_examples/${filePath}`)
       .then((module) => {
         const lines = module.default.split('\n');
         const mainIndex = lines.findIndex((line) => line.trim().startsWith('if __name__ == '));

diff --git a/docs/docs-next/src/styles/custom.scss b/docs/docs-next/src/styles/custom.scss
@@ -15,6 +15,7 @@ html {
   font-family: var(--ifm-font-family-base);
   background: var(--theme-color-background-default);
 }
+
 article {
   max-width: 720px;
   margin: 0 auto;

diff --git a/docs/docs-next/src/styles/theme-light.scss b/docs/docs-next/src/styles/theme-light.scss
@@ -77,7 +77,7 @@
   --ifm-menu-color-active: var(--theme-color-background-blue);
 
   // docusaurus
-  --docusaurus-highlighted-code-line-bg: var(--theme-background-light);
+  --docusaurus-highlighted-code-line-bg: var(--theme-color-background-blue);
 
   // infima shadow levels
   // generated from https://www.joshwcomeau.com/shadow-palette/