From 18f039ecc814fe9a33f451d2697425d05f51e3dc Mon Sep 17 00:00:00 2001
From: Pedram Navid <1045990+PedramNavid@users.noreply.github.com>
Date: Mon, 9 Sep 2024 14:13:37 -0700
Subject: [PATCH] [docs-beta] Rework sidebar (#24305)
## Summary & Motivation
After the Docathon, I realized our Sidebar had gotten out of hand. This
is one attempt at taming it. I think we went too far down the path of
'jobs to be done' which made the sidebar harder to read and parse.
I went with three over-arching categories: build, scale, deploy to help
organize the high-level flows of a user as they build with Dagster.
Within each category, I split things into smaller groups: e.g. within
Build we have: Create a pipeline, Configure behavior, abstracting logic,
and common use cases
Within Scale, I focused on things like creating resources, adding data
quality, and automation.
In Deployment, we have self-hosting, and Dagster plus, along with things
like secrets management, and locations.
I also moved all the guides into a single folder. Having many subfolders
with specific names makes it hard to refactor the sidebar quickly. We
can but them back into folders once we have settled on a sidebar method
if needed.
I am least confident in the 'Scale' category, open to ideas here.
## How I Tested These Changes
Collapsed
Some open
## Changelog
NOCHANGELOG
---
docs/docs-beta/docs/concepts/automation.md | 6 +-
.../access/rbac/user-roles-permissions.md | 2 +-
.../dagster-plus/insights/asset-metadata.md | 2 +-
.../docs/dagster-plus/saved-views.md | 2 +-
.../docs/dagster-plus/whats-dagster-plus.md | 4 +-
docs/docs-beta/docs/guides/TBD.md | 3 -
.../guides/{monitor-alert => }/alerting.md | 0
.../{deployment => }/amazon-web-services.md | 0
.../guides/{external-systems => }/apis.md | 2 +-
.../{quality-testing => }/asset-checks.md | 0
.../{data-modeling => }/asset-dependencies.md | 0
.../asset-factories-with-deps.md | 4 +-
.../{data-modeling => }/asset-factories.md | 2 +-
.../guides/{automation => }/asset-sensors.md | 2 +-
.../{external-systems => }/authentication.md | 0
docs/docs-beta/docs/guides/automation.md | 6 +-
.../backfill.md | 0
.../{external-systems => }/build-your-own.md | 0
.../{external-systems => }/cloud-services.md | 0
.../guides/{deployment => }/code-locations.md | 0
.../{data-modeling => }/configuring-assets.md | 2 +-
.../guides/{automation => }/configuring.md | 0
.../{monitor-alert => }/custom-logging.md | 0
.../custom-metrics-logs.md | 0
.../guides/{deployment => }/dagster-plus.md | 0
.../guides/{data-modeling => }/data-assets.md | 7 +-
.../data-freshness-testing.md | 0
docs/docs-beta/docs/guides/data-modeling.md | 9 -
.../{external-systems => }/databases.md | 2 +-
.../docs/guides/declarative-automation.md | 4 +
.../docs/guides/{deployment => }/docker.md | 0
.../{data-modeling => }/external-assets.md | 10 +-
.../docs-beta/docs/guides/external-systems.md | 5 -
.../{deployment => }/google-cloud-platform.md | 0
.../docs/{guides.md => guides/index.md} | 0
.../ingesting-data.md | 4 +-
.../docs/guides/ingestion-transformation.md | 3 -
.../{external-systems => }/io-managers.md | 2 +-
.../guides/{deployment => }/kubernetes.md | 0
.../guides/{data-modeling => }/metadata.md | 4 +-
.../{deployment => }/microsoft-azure.md | 0
docs/docs-beta/docs/guides/monitor-alert.md | 5 -
.../{external-systems => }/non-python.md | 3 +-
.../{data-modeling => }/partitioning.md | 2 +-
.../guides/{external-systems => }/pipes.md | 0
docs/docs-beta/docs/guides/quality-testing.md | 3 -
docs/docs-beta/docs/guides/resources.md | 6 +
.../{tbd => }/running-local-ui-development.md | 0
.../docs/guides/{automation => }/schedules.md | 4 +-
.../docs/guides/{deployment => }/secrets.md | 0
.../docs/guides/{tbd => }/selection-syntax.md | 0
.../self-hosted-to-dagster-plus.md | 0
.../docs/guides/{automation => }/sensors.md | 2 +-
.../{troubleshooting => }/some-guide.md | 0
docs/docs-beta/docs/guides/tbd.md | 3 -
.../transform-dbt.md | 1 +
docs/docs-beta/docs/guides/troubleshooting.md | 3 -
.../unit-tests-assets-and-ops.md | 0
docs/docs-beta/docs/tutorial/installation.md | 82 ++++++++
docs/docs-beta/sidebars.ts | 186 +++++-------------
docs/docs-beta/src/components/Cards.tsx | 4 +-
docs/docs-beta/src/styles/custom.scss | 23 ++-
docs/sphinx/README.md | 12 ++
.../getting-started/hello-world.py | 16 ++
64 files changed, 225 insertions(+), 217 deletions(-)
delete mode 100644 docs/docs-beta/docs/guides/TBD.md
rename docs/docs-beta/docs/guides/{monitor-alert => }/alerting.md (100%)
rename docs/docs-beta/docs/guides/{deployment => }/amazon-web-services.md (100%)
rename docs/docs-beta/docs/guides/{external-systems => }/apis.md (98%)
rename docs/docs-beta/docs/guides/{quality-testing => }/asset-checks.md (100%)
rename docs/docs-beta/docs/guides/{data-modeling => }/asset-dependencies.md (100%)
rename docs/docs-beta/docs/guides/{data-modeling => }/asset-factories-with-deps.md (95%)
rename docs/docs-beta/docs/guides/{data-modeling => }/asset-factories.md (98%)
rename docs/docs-beta/docs/guides/{automation => }/asset-sensors.md (98%)
rename docs/docs-beta/docs/guides/{external-systems => }/authentication.md (100%)
rename docs/docs-beta/docs/guides/{ingestion-transformation => }/backfill.md (100%)
rename docs/docs-beta/docs/guides/{external-systems => }/build-your-own.md (100%)
rename docs/docs-beta/docs/guides/{external-systems => }/cloud-services.md (100%)
rename docs/docs-beta/docs/guides/{deployment => }/code-locations.md (100%)
rename docs/docs-beta/docs/guides/{data-modeling => }/configuring-assets.md (97%)
rename docs/docs-beta/docs/guides/{automation => }/configuring.md (100%)
rename docs/docs-beta/docs/guides/{monitor-alert => }/custom-logging.md (100%)
rename docs/docs-beta/docs/guides/{monitor-alert => }/custom-metrics-logs.md (100%)
rename docs/docs-beta/docs/guides/{deployment => }/dagster-plus.md (100%)
rename docs/docs-beta/docs/guides/{data-modeling => }/data-assets.md (94%)
rename docs/docs-beta/docs/guides/{quality-testing => }/data-freshness-testing.md (100%)
delete mode 100644 docs/docs-beta/docs/guides/data-modeling.md
rename docs/docs-beta/docs/guides/{external-systems => }/databases.md (99%)
create mode 100644 docs/docs-beta/docs/guides/declarative-automation.md
rename docs/docs-beta/docs/guides/{deployment => }/docker.md (100%)
rename docs/docs-beta/docs/guides/{data-modeling => }/external-assets.md (90%)
delete mode 100644 docs/docs-beta/docs/guides/external-systems.md
rename docs/docs-beta/docs/guides/{deployment => }/google-cloud-platform.md (100%)
rename docs/docs-beta/docs/{guides.md => guides/index.md} (100%)
rename docs/docs-beta/docs/guides/{ingestion-transformation => }/ingesting-data.md (97%)
delete mode 100644 docs/docs-beta/docs/guides/ingestion-transformation.md
rename docs/docs-beta/docs/guides/{external-systems => }/io-managers.md (98%)
rename docs/docs-beta/docs/guides/{deployment => }/kubernetes.md (100%)
rename docs/docs-beta/docs/guides/{data-modeling => }/metadata.md (98%)
rename docs/docs-beta/docs/guides/{deployment => }/microsoft-azure.md (100%)
delete mode 100644 docs/docs-beta/docs/guides/monitor-alert.md
rename docs/docs-beta/docs/guides/{external-systems => }/non-python.md (98%)
rename docs/docs-beta/docs/guides/{data-modeling => }/partitioning.md (99%)
rename docs/docs-beta/docs/guides/{external-systems => }/pipes.md (100%)
delete mode 100644 docs/docs-beta/docs/guides/quality-testing.md
create mode 100644 docs/docs-beta/docs/guides/resources.md
rename docs/docs-beta/docs/guides/{tbd => }/running-local-ui-development.md (100%)
rename docs/docs-beta/docs/guides/{automation => }/schedules.md (95%)
rename docs/docs-beta/docs/guides/{deployment => }/secrets.md (100%)
rename docs/docs-beta/docs/guides/{tbd => }/selection-syntax.md (100%)
rename docs/docs-beta/docs/guides/{deployment => }/self-hosted-to-dagster-plus.md (100%)
rename docs/docs-beta/docs/guides/{automation => }/sensors.md (96%)
rename docs/docs-beta/docs/guides/{troubleshooting => }/some-guide.md (100%)
delete mode 100644 docs/docs-beta/docs/guides/tbd.md
rename docs/docs-beta/docs/guides/{ingestion-transformation => }/transform-dbt.md (98%)
delete mode 100644 docs/docs-beta/docs/guides/troubleshooting.md
rename docs/docs-beta/docs/guides/{quality-testing => }/unit-tests-assets-and-ops.md (100%)
create mode 100644 docs/docs-beta/docs/tutorial/installation.md
create mode 100644 docs/sphinx/README.md
create mode 100644 examples/docs_beta_snippets/docs_beta_snippets/getting-started/hello-world.py
diff --git a/docs/docs-beta/docs/concepts/automation.md b/docs/docs-beta/docs/concepts/automation.md
index de4a9b3269bf1..58a8cfafe497f 100644
--- a/docs/docs-beta/docs/concepts/automation.md
+++ b/docs/docs-beta/docs/concepts/automation.md
@@ -4,11 +4,11 @@ title: About Automation
There are several ways to automate the execution of your data pipelines with Dagster.
-The first system, and the most basic, is the [Schedule](/guides/automation/schedules), which responds to time.
+The first system, and the most basic, is the [Schedule](/guides/schedules), which responds to time.
-[Sensors](/guides/automation/sensors) are like schedules, but they respond to an external event defined by the user.
+[Sensors](/guides/sensors) are like schedules, but they respond to an external event defined by the user.
-[Asset Sensors](/guides/automation/asset-sensors) are a special case of sensor that responds to changes in asset materialization
+[Asset Sensors](/guides/asset-sensors) are a special case of sensor that responds to changes in asset materialization
as reported by the Event Log.
Finally, the Declarative Automation system is a
diff --git a/docs/docs-beta/docs/dagster-plus/access/rbac/user-roles-permissions.md b/docs/docs-beta/docs/dagster-plus/access/rbac/user-roles-permissions.md
index 761f3a9fc0777..c8e94ca526d51 100644
--- a/docs/docs-beta/docs/dagster-plus/access/rbac/user-roles-permissions.md
+++ b/docs/docs-beta/docs/dagster-plus/access/rbac/user-roles-permissions.md
@@ -117,7 +117,7 @@ TODO: add picture previously at "/images/dagster-cloud/user-token-management/cod
| Start and stop [schedules](/concepts/schedules) | ❌ | ❌ | ✅ | ✅ | ✅ |
| Start and stop [schedules](/concepts/sensors) | ❌ | ❌ | ✅ | ✅ | ✅ |
| Wipe assets | ❌ | ❌ | ✅ | ✅ | ✅ |
-| Launch and cancel [schedules](/guides/ingestion-transformation/backfill) | ❌ | ✅ | ✅ | ✅ | ✅ |
+| Launch and cancel [schedules](/guides/backfill) | ❌ | ✅ | ✅ | ✅ | ✅ |
| Add dynamic partitions | ❌ | ❌ | ✅ | ✅ | ✅ |
### Deployments
diff --git a/docs/docs-beta/docs/dagster-plus/insights/asset-metadata.md b/docs/docs-beta/docs/dagster-plus/insights/asset-metadata.md
index ea93cdf30861d..cf7c53f2970bf 100644
--- a/docs/docs-beta/docs/dagster-plus/insights/asset-metadata.md
+++ b/docs/docs-beta/docs/dagster-plus/insights/asset-metadata.md
@@ -25,7 +25,7 @@ You'll need one or more assets that emit the same metadata key at run time. Insi
are most valuable when you have multiple assets that emit the same kind of metadata, such as
such as the number of rows processed or the size of a file uploaded to object storage.
-Follow [the metadata guide](/guides/data-modeling/metadata#attaching-metadata-to-an-asset-at-runtime) to add numeric metadata
+Follow [the metadata guide](/guides/metadata#attaching-metadata-to-an-asset-at-runtime) to add numeric metadata
to your asset materializations.
## Step 2: Enable viewing your metadata in Dagster+ Insights
diff --git a/docs/docs-beta/docs/dagster-plus/saved-views.md b/docs/docs-beta/docs/dagster-plus/saved-views.md
index dbefe35821eac..3f3c0a7bc1ef4 100644
--- a/docs/docs-beta/docs/dagster-plus/saved-views.md
+++ b/docs/docs-beta/docs/dagster-plus/saved-views.md
@@ -19,7 +19,7 @@ In this guide, you'll learn how to create, access, and share catalog views with
Prerequisites
- **Organization Admin**, **Admin**, or **Editor** permissions on Dagster+
-- Familiarity with [Assets](/concepts/assets) and [Asset metadata](/guides/data-modeling/metadata)
+- Familiarity with [Assets](/concepts/assets) and [Asset metadata](/guides/metadata)
diff --git a/docs/docs-beta/docs/dagster-plus/whats-dagster-plus.md b/docs/docs-beta/docs/dagster-plus/whats-dagster-plus.md
index e0357aa213103..0fe6016026500 100644
--- a/docs/docs-beta/docs/dagster-plus/whats-dagster-plus.md
+++ b/docs/docs-beta/docs/dagster-plus/whats-dagster-plus.md
@@ -10,7 +10,7 @@ Dagster+ is a managed orchestration platform built on top of Dagster's open sour
Dagster+ is built to be the most performant, reliable, and cost effective way for data engineering teams to run Dagster in production. Dagster+ is also great for students, researchers, or individuals who want to explore Dagster with minimal overhead.
-Dagster+ comes in two flavors: a fully [Serverless](/dagster-plus/deployment/serverless) offering and a [Hybrid](/dagster-plus/deployment/hybrid) offering. In both cases, Dagster+ does the hard work of managing your data orchestration control plane. Compared to a [Dagster open source deployment](/guides/deployment/), Dagster+ manages:
+Dagster+ comes in two flavors: a fully [Serverless](/dagster-plus/deployment/serverless) offering and a [Hybrid](/dagster-plus/deployment/hybrid) offering. In both cases, Dagster+ does the hard work of managing your data orchestration control plane. Compared to a [Dagster open source deployment](/guides/), Dagster+ manages:
- Dagster's web UI at https://dagster.plus
- Metadata stores for data cataloging and cost insights
@@ -33,5 +33,5 @@ Ready to [get started](/dagster-plus/getting-started)?
- Learn more about Dagster+ [pricing and plan types](https://dagster.io/pricing) or [contact the Dagster team](https://dagster.io/contact)
- Dagster+ includes support, [click here](https://dagster.io/support) to learn more.
- Dagster+ is HIPAA compliant, SOC 2 Type II certified, and meets GDPR requirements. Learn more about Dagster+[ security](https://dagster.io/security).
-- Migrate [from a Dagster open source deployment to Dagster+](/guides/deployment/self-hosted-to-dagster-plus)
+- Migrate [from a Dagster open source deployment to Dagster+](/guides/self-hosted-to-dagster-plus)
- Dagster+ [status page](https://dagstercloud.statuspage.io/)
diff --git a/docs/docs-beta/docs/guides/TBD.md b/docs/docs-beta/docs/guides/TBD.md
deleted file mode 100644
index 2de204e4176c3..0000000000000
--- a/docs/docs-beta/docs/guides/TBD.md
+++ /dev/null
@@ -1,3 +0,0 @@
----
-title: TBD
----
\ No newline at end of file
diff --git a/docs/docs-beta/docs/guides/monitor-alert/alerting.md b/docs/docs-beta/docs/guides/alerting.md
similarity index 100%
rename from docs/docs-beta/docs/guides/monitor-alert/alerting.md
rename to docs/docs-beta/docs/guides/alerting.md
diff --git a/docs/docs-beta/docs/guides/deployment/amazon-web-services.md b/docs/docs-beta/docs/guides/amazon-web-services.md
similarity index 100%
rename from docs/docs-beta/docs/guides/deployment/amazon-web-services.md
rename to docs/docs-beta/docs/guides/amazon-web-services.md
diff --git a/docs/docs-beta/docs/guides/external-systems/apis.md b/docs/docs-beta/docs/guides/apis.md
similarity index 98%
rename from docs/docs-beta/docs/guides/external-systems/apis.md
rename to docs/docs-beta/docs/guides/apis.md
index bd2aa90048b1e..ba05a0f42efc0 100644
--- a/docs/docs-beta/docs/guides/external-systems/apis.md
+++ b/docs/docs-beta/docs/guides/apis.md
@@ -74,7 +74,7 @@ You can also fetch environment variables using the `os` library. Dagster treats
## Next steps
-- [Authenticate to a resource](/guides/external-systems/authentication.md)
+- [Authenticate to a resource](/guides/authentication.md)
- [Use different resources in different execution environments](/todo)
- [Set environment variables in Dagster+](/todo)
- Learn what [Dagster-provided resources](/todo) are available to use
diff --git a/docs/docs-beta/docs/guides/quality-testing/asset-checks.md b/docs/docs-beta/docs/guides/asset-checks.md
similarity index 100%
rename from docs/docs-beta/docs/guides/quality-testing/asset-checks.md
rename to docs/docs-beta/docs/guides/asset-checks.md
diff --git a/docs/docs-beta/docs/guides/data-modeling/asset-dependencies.md b/docs/docs-beta/docs/guides/asset-dependencies.md
similarity index 100%
rename from docs/docs-beta/docs/guides/data-modeling/asset-dependencies.md
rename to docs/docs-beta/docs/guides/asset-dependencies.md
diff --git a/docs/docs-beta/docs/guides/data-modeling/asset-factories-with-deps.md b/docs/docs-beta/docs/guides/asset-factories-with-deps.md
similarity index 95%
rename from docs/docs-beta/docs/guides/data-modeling/asset-factories-with-deps.md
rename to docs/docs-beta/docs/guides/asset-factories-with-deps.md
index 8e45694b6c63c..8cef0ea32129f 100644
--- a/docs/docs-beta/docs/guides/data-modeling/asset-factories-with-deps.md
+++ b/docs/docs-beta/docs/guides/asset-factories-with-deps.md
@@ -1,7 +1,7 @@
---
title: 'Programmatically defining dependencies using asset factories'
sidebar_position: 60
-sidebar_label: 'Programmatically defining dependencies'
+sidebar_label: 'Asset Factories (2)'
---
In data engineering, it's often helpful to reuse code to define similar assets. For example, you may want to represent every file in a directory as an asset.
@@ -20,7 +20,7 @@ Using an asset factory reduces complexity and creates a pluggable entry point to
Prerequisites
-This guide builds upon the concepts in the [asset factories](/guides/data-modeling/asset-factories) tutorial.
+This guide builds upon the concepts in the [asset factories](/guides/asset-factories) tutorial.
---
diff --git a/docs/docs-beta/docs/guides/data-modeling/asset-factories.md b/docs/docs-beta/docs/guides/asset-factories.md
similarity index 98%
rename from docs/docs-beta/docs/guides/data-modeling/asset-factories.md
rename to docs/docs-beta/docs/guides/asset-factories.md
index f87ebef74e308..752b9981cea42 100644
--- a/docs/docs-beta/docs/guides/data-modeling/asset-factories.md
+++ b/docs/docs-beta/docs/guides/asset-factories.md
@@ -1,7 +1,7 @@
---
title: 'Creating domain-specific languages with asset factories'
sidebar_position: 60
-sidebar_label: 'Creating domain-specific languages'
+sidebar_label: 'Asset factories'
---
Often in data engineering, you'll find yourself needing to create a large number of similar assets. For example:
diff --git a/docs/docs-beta/docs/guides/automation/asset-sensors.md b/docs/docs-beta/docs/guides/asset-sensors.md
similarity index 98%
rename from docs/docs-beta/docs/guides/automation/asset-sensors.md
rename to docs/docs-beta/docs/guides/asset-sensors.md
index b8fcbb3888865..a6b21ec422fe2 100644
--- a/docs/docs-beta/docs/guides/automation/asset-sensors.md
+++ b/docs/docs-beta/docs/guides/asset-sensors.md
@@ -1,7 +1,7 @@
---
title: Trigger cross-job dependencies with Asset Sensors
sidebar_position: 30
-sidebar_label: Trigger cross-job dependencies
+sidebar_label: Cross-job dependencies
---
Asset sensors in Dagster provide a powerful mechanism for monitoring asset materializations and triggering downstream computations or notifications based on those events.
diff --git a/docs/docs-beta/docs/guides/external-systems/authentication.md b/docs/docs-beta/docs/guides/authentication.md
similarity index 100%
rename from docs/docs-beta/docs/guides/external-systems/authentication.md
rename to docs/docs-beta/docs/guides/authentication.md
diff --git a/docs/docs-beta/docs/guides/automation.md b/docs/docs-beta/docs/guides/automation.md
index a54014b37e9b5..6eb2f287c3aab 100644
--- a/docs/docs-beta/docs/guides/automation.md
+++ b/docs/docs-beta/docs/guides/automation.md
@@ -45,7 +45,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
-For examples of how to create schedules, see [How-To Use Schedules](/guides/automation/schedules).
+For examples of how to create schedules, see [How-To Use Schedules](/guides/schedules).
For more information about how Schedules work, see [About Schedules](/concepts/schedules).
@@ -62,7 +62,7 @@ Like schedules, sensors operate on a selection of assets, known as [Jobs](/conce
- You need event-driven automation
- You want to react to changes in external systems
-For more examples of how to create sensors, see the [How-To Use Sensors](/guides/automation/sensors) guide.
+For more examples of how to create sensors, see the [How-To Use Sensors](/guides/sensors) guide.
For more information about how sensors work, see the [About Sensors](/concepts/sensors) concept page.
@@ -75,7 +75,7 @@ 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
-For more examples of how to create asset sensors, see the [How-To Use Asset Sensors](/guides/automation/asset-sensors) guide.
+For more examples of how to create asset sensors, see the [How-To Use Asset Sensors](/guides/asset-sensors) guide.
## Declarative Automation
diff --git a/docs/docs-beta/docs/guides/ingestion-transformation/backfill.md b/docs/docs-beta/docs/guides/backfill.md
similarity index 100%
rename from docs/docs-beta/docs/guides/ingestion-transformation/backfill.md
rename to docs/docs-beta/docs/guides/backfill.md
diff --git a/docs/docs-beta/docs/guides/external-systems/build-your-own.md b/docs/docs-beta/docs/guides/build-your-own.md
similarity index 100%
rename from docs/docs-beta/docs/guides/external-systems/build-your-own.md
rename to docs/docs-beta/docs/guides/build-your-own.md
diff --git a/docs/docs-beta/docs/guides/external-systems/cloud-services.md b/docs/docs-beta/docs/guides/cloud-services.md
similarity index 100%
rename from docs/docs-beta/docs/guides/external-systems/cloud-services.md
rename to docs/docs-beta/docs/guides/cloud-services.md
diff --git a/docs/docs-beta/docs/guides/deployment/code-locations.md b/docs/docs-beta/docs/guides/code-locations.md
similarity index 100%
rename from docs/docs-beta/docs/guides/deployment/code-locations.md
rename to docs/docs-beta/docs/guides/code-locations.md
diff --git a/docs/docs-beta/docs/guides/data-modeling/configuring-assets.md b/docs/docs-beta/docs/guides/configuring-assets.md
similarity index 97%
rename from docs/docs-beta/docs/guides/data-modeling/configuring-assets.md
rename to docs/docs-beta/docs/guides/configuring-assets.md
index 51eaa5650ba4f..6b39cc548fdd7 100644
--- a/docs/docs-beta/docs/guides/data-modeling/configuring-assets.md
+++ b/docs/docs-beta/docs/guides/configuring-assets.md
@@ -1,6 +1,6 @@
---
title: Configuring assets using the Dagster UI
-sidebar_label: Configuring assets using the Dagster UI
+sidebar_label: Configure asset runs
sidebar_position: 50
---
diff --git a/docs/docs-beta/docs/guides/automation/configuring.md b/docs/docs-beta/docs/guides/configuring.md
similarity index 100%
rename from docs/docs-beta/docs/guides/automation/configuring.md
rename to docs/docs-beta/docs/guides/configuring.md
diff --git a/docs/docs-beta/docs/guides/monitor-alert/custom-logging.md b/docs/docs-beta/docs/guides/custom-logging.md
similarity index 100%
rename from docs/docs-beta/docs/guides/monitor-alert/custom-logging.md
rename to docs/docs-beta/docs/guides/custom-logging.md
diff --git a/docs/docs-beta/docs/guides/monitor-alert/custom-metrics-logs.md b/docs/docs-beta/docs/guides/custom-metrics-logs.md
similarity index 100%
rename from docs/docs-beta/docs/guides/monitor-alert/custom-metrics-logs.md
rename to docs/docs-beta/docs/guides/custom-metrics-logs.md
diff --git a/docs/docs-beta/docs/guides/deployment/dagster-plus.md b/docs/docs-beta/docs/guides/dagster-plus.md
similarity index 100%
rename from docs/docs-beta/docs/guides/deployment/dagster-plus.md
rename to docs/docs-beta/docs/guides/dagster-plus.md
diff --git a/docs/docs-beta/docs/guides/data-modeling/data-assets.md b/docs/docs-beta/docs/guides/data-assets.md
similarity index 94%
rename from docs/docs-beta/docs/guides/data-modeling/data-assets.md
rename to docs/docs-beta/docs/guides/data-assets.md
index 8e54849d9d010..dd566e86c6ac9 100644
--- a/docs/docs-beta/docs/guides/data-modeling/data-assets.md
+++ b/docs/docs-beta/docs/guides/data-assets.md
@@ -1,5 +1,6 @@
---
title: "Defining data assets with decorators"
+sidebar_label: "Create Assets"
sidebar_position: 10
---
@@ -79,6 +80,6 @@ flowchart LR
## Next steps
-- Learn to create [dependencies between assets](/guides/data-modeling/asset-dependencies)
-- Enrich Dagster's built-in data catalog with [asset metadata](/guides/data-modeling/metadata)
-- Learn to use a [factory pattern](/guides/data-modeling/asset-factories) to create multiple, similar assets
+- Learn to create [dependencies between assets](/guides/asset-dependencies)
+- Enrich Dagster's built-in data catalog with [asset metadata](/guides/metadata)
+- Learn to use a [factory pattern](/guides/asset-factories) to create multiple, similar assets
diff --git a/docs/docs-beta/docs/guides/quality-testing/data-freshness-testing.md b/docs/docs-beta/docs/guides/data-freshness-testing.md
similarity index 100%
rename from docs/docs-beta/docs/guides/quality-testing/data-freshness-testing.md
rename to docs/docs-beta/docs/guides/data-freshness-testing.md
diff --git a/docs/docs-beta/docs/guides/data-modeling.md b/docs/docs-beta/docs/guides/data-modeling.md
deleted file mode 100644
index 06853b2acc36b..0000000000000
--- a/docs/docs-beta/docs/guides/data-modeling.md
+++ /dev/null
@@ -1,9 +0,0 @@
----
-title: "Model your data"
----
-
-# Model your data
-
-- Data Assets
-- Partitions
-- Groups / Metadata / Tags
\ No newline at end of file
diff --git a/docs/docs-beta/docs/guides/external-systems/databases.md b/docs/docs-beta/docs/guides/databases.md
similarity index 99%
rename from docs/docs-beta/docs/guides/external-systems/databases.md
rename to docs/docs-beta/docs/guides/databases.md
index e81e9f7946dad..886969bac58e2 100644
--- a/docs/docs-beta/docs/guides/external-systems/databases.md
+++ b/docs/docs-beta/docs/guides/databases.md
@@ -56,6 +56,6 @@ See [Dagster Integrations](https://dagster.io/integrations) for resource types t
## Next steps
-- Explore how to use resources for [Connecting to APIs](/guides/external-systems/apis)
+- Explore how to use resources for [Connecting to APIs](/guides/apis)
- Go deeper into [Understanding Resources](/concepts/resources)
diff --git a/docs/docs-beta/docs/guides/declarative-automation.md b/docs/docs-beta/docs/guides/declarative-automation.md
new file mode 100644
index 0000000000000..7df4b1f43a0a4
--- /dev/null
+++ b/docs/docs-beta/docs/guides/declarative-automation.md
@@ -0,0 +1,4 @@
+---
+title: "Declarative automation"
+sidebar_label: "Declarative automation"
+---
\ No newline at end of file
diff --git a/docs/docs-beta/docs/guides/deployment/docker.md b/docs/docs-beta/docs/guides/docker.md
similarity index 100%
rename from docs/docs-beta/docs/guides/deployment/docker.md
rename to docs/docs-beta/docs/guides/docker.md
diff --git a/docs/docs-beta/docs/guides/data-modeling/external-assets.md b/docs/docs-beta/docs/guides/external-assets.md
similarity index 90%
rename from docs/docs-beta/docs/guides/data-modeling/external-assets.md
rename to docs/docs-beta/docs/guides/external-assets.md
index 60273effde921..3a09895e80bad 100644
--- a/docs/docs-beta/docs/guides/data-modeling/external-assets.md
+++ b/docs/docs-beta/docs/guides/external-assets.md
@@ -1,7 +1,7 @@
---
title: Representing external data sources with external assets
sidebar_position: 80
-sidebar_label: 'Representing external data sources'
+sidebar_label: 'External data assets'
---
One of Dagster's goals is to present a single unified lineage of all of the data assets in an organization. This can include assets orchestrated by Dagster and assets orchestrated by other systems.
@@ -26,8 +26,8 @@ Examples of external assets could be files in a data lake that are populated by
To follow the steps in this guide, you'll need:
-- A basic understanding of Dagster and assets. See the [Quick Start](/getting-started/quickstart) tutorial for an overview.
-- Familiarity with [Sensors](/guides/automation/sensors)
+- A basic understanding of Dagster and assets. See the [Quick Start](/tutorial/quick-start) tutorial for an overview.
+- Familiarity with [Sensors](/guides/sensors)
---
@@ -48,13 +48,13 @@ There are two main ways to do this: "pulling" external assets events with sensor
### "Pulling" with sensors
-You can use a Dagster [sensor](/guides/automation/sensors) to regularly poll the external system and "pull" information about the external asset into Dagster.
+You can use a Dagster [sensor](/guides/sensors) to regularly poll the external system and "pull" information about the external asset into Dagster.
For example, here's how you would poll an external system (like an SFTP server) to update an external asset whenever the file is changed.
-See the [sensors guide](/guides/automation/sensors) for more information about sensors.
+See the [sensors guide](/guides/sensors) for more information about sensors.
### "Pushing" with the REST API
diff --git a/docs/docs-beta/docs/guides/external-systems.md b/docs/docs-beta/docs/guides/external-systems.md
deleted file mode 100644
index cef8e5551d86a..0000000000000
--- a/docs/docs-beta/docs/guides/external-systems.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-title: "External systems"
----
-
-# Data assets
diff --git a/docs/docs-beta/docs/guides/deployment/google-cloud-platform.md b/docs/docs-beta/docs/guides/google-cloud-platform.md
similarity index 100%
rename from docs/docs-beta/docs/guides/deployment/google-cloud-platform.md
rename to docs/docs-beta/docs/guides/google-cloud-platform.md
diff --git a/docs/docs-beta/docs/guides.md b/docs/docs-beta/docs/guides/index.md
similarity index 100%
rename from docs/docs-beta/docs/guides.md
rename to docs/docs-beta/docs/guides/index.md
diff --git a/docs/docs-beta/docs/guides/ingestion-transformation/ingesting-data.md b/docs/docs-beta/docs/guides/ingesting-data.md
similarity index 97%
rename from docs/docs-beta/docs/guides/ingestion-transformation/ingesting-data.md
rename to docs/docs-beta/docs/guides/ingesting-data.md
index e9864ae468896..d560bc601efc8 100644
--- a/docs/docs-beta/docs/guides/ingestion-transformation/ingesting-data.md
+++ b/docs/docs-beta/docs/guides/ingesting-data.md
@@ -2,7 +2,7 @@
title: Ingesting data with Dagster
description: Learn how to orchestrate data ingestion with Dagster
sidebar_position: 10
-sidebar_label: Ingesting data
+sidebar_label: Ingest data with embedded-elt
---
Dagster is often used to orchestrate the ingestion of data into a data warehouse or data lake, where it can be queried and transformed. Dagster integrates with several tools that are purpose-built for data ingestion, and it also enables writing custom code for ingesting data.
@@ -58,4 +58,4 @@ For example, imagine there's a CSV file of counties on the internet and you want
{/* TODO add next steps */}
-- Learn how to [transform data using Dagster's dbt integration](/guides/ingestion-transformation/transform-dbt)
+- Learn how to [transform data using Dagster's dbt integration](/guides/transform-dbt)
diff --git a/docs/docs-beta/docs/guides/ingestion-transformation.md b/docs/docs-beta/docs/guides/ingestion-transformation.md
deleted file mode 100644
index 4c04f2078f22b..0000000000000
--- a/docs/docs-beta/docs/guides/ingestion-transformation.md
+++ /dev/null
@@ -1,3 +0,0 @@
----
-title: Ingestion
----
diff --git a/docs/docs-beta/docs/guides/external-systems/io-managers.md b/docs/docs-beta/docs/guides/io-managers.md
similarity index 98%
rename from docs/docs-beta/docs/guides/external-systems/io-managers.md
rename to docs/docs-beta/docs/guides/io-managers.md
index a0737ece710bd..93c84efd4ba84 100644
--- a/docs/docs-beta/docs/guides/external-systems/io-managers.md
+++ b/docs/docs-beta/docs/guides/io-managers.md
@@ -1,7 +1,7 @@
---
title: "Managing stored data with I/O managers"
sidebar_position: 50
-sidebar_label: "Storing data with I/O managers"
+sidebar_label: "I/O managers"
---
I/O managers in Dagster provide a way to separate the code that's responsible for logical data transformation from the code that's responsible for reading and writing the results. This can help reduce boiler plate code and make it easy to swap out where your data is stored.
diff --git a/docs/docs-beta/docs/guides/deployment/kubernetes.md b/docs/docs-beta/docs/guides/kubernetes.md
similarity index 100%
rename from docs/docs-beta/docs/guides/deployment/kubernetes.md
rename to docs/docs-beta/docs/guides/kubernetes.md
diff --git a/docs/docs-beta/docs/guides/data-modeling/metadata.md b/docs/docs-beta/docs/guides/metadata.md
similarity index 98%
rename from docs/docs-beta/docs/guides/data-modeling/metadata.md
rename to docs/docs-beta/docs/guides/metadata.md
index 70e7024deebb5..3292ae57d4d60 100644
--- a/docs/docs-beta/docs/guides/data-modeling/metadata.md
+++ b/docs/docs-beta/docs/guides/metadata.md
@@ -2,7 +2,7 @@
title: 'Adding tags and metadata to assets'
description: 'Learn how to add tags and metadata to assets to improve observability in Dagster'
sidebar_position: 40
-sidebar_label: 'Enriching assets with metadata'
+sidebar_label: 'Add metadata'
---
Assets feature prominently in the Dagster UI. It's often helpful to attach information to assets to understand where they're stored, what they contain, and how they should be organized.
@@ -156,7 +156,7 @@ Dagster can automatically attach code references to your assets during local dev
### Customizing code references
-If you want to customize how code references are attached - such as when you are building [domain-specific languages with asset factories](/guides/data-modeling/asset-factories) - you can manually add the `dagster/code_references` metadata to your asset definitions.
+If you want to customize how code references are attached - such as when you are building [domain-specific languages with asset factories](/guides/asset-factories) - you can manually add the `dagster/code_references` metadata to your asset definitions.
diff --git a/docs/docs-beta/docs/guides/deployment/microsoft-azure.md b/docs/docs-beta/docs/guides/microsoft-azure.md
similarity index 100%
rename from docs/docs-beta/docs/guides/deployment/microsoft-azure.md
rename to docs/docs-beta/docs/guides/microsoft-azure.md
diff --git a/docs/docs-beta/docs/guides/monitor-alert.md b/docs/docs-beta/docs/guides/monitor-alert.md
deleted file mode 100644
index 7997bf8f7d8c3..0000000000000
--- a/docs/docs-beta/docs/guides/monitor-alert.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-title: "Monitoring"
----
-
-# Monitoring
diff --git a/docs/docs-beta/docs/guides/external-systems/non-python.md b/docs/docs-beta/docs/guides/non-python.md
similarity index 98%
rename from docs/docs-beta/docs/guides/external-systems/non-python.md
rename to docs/docs-beta/docs/guides/non-python.md
index 01c90612362a4..a4429f9c1a768 100644
--- a/docs/docs-beta/docs/guides/external-systems/non-python.md
+++ b/docs/docs-beta/docs/guides/non-python.md
@@ -1,5 +1,6 @@
---
-title: "Running non-Python languages"
+title: "External Compute"
+sidebar_label: "Dagster Pipes"
sidebar_position: 60
---
diff --git a/docs/docs-beta/docs/guides/data-modeling/partitioning.md b/docs/docs-beta/docs/guides/partitioning.md
similarity index 99%
rename from docs/docs-beta/docs/guides/data-modeling/partitioning.md
rename to docs/docs-beta/docs/guides/partitioning.md
index da12406d65f2e..339e0ec2034a2 100644
--- a/docs/docs-beta/docs/guides/data-modeling/partitioning.md
+++ b/docs/docs-beta/docs/guides/partitioning.md
@@ -1,7 +1,7 @@
---
title: Partitioning assets
description: Learn how to partition your data in Dagster.
-sidebar_label: Partitioning assets
+sidebar_label: Partition data
sidebar_position: 30
---
diff --git a/docs/docs-beta/docs/guides/external-systems/pipes.md b/docs/docs-beta/docs/guides/pipes.md
similarity index 100%
rename from docs/docs-beta/docs/guides/external-systems/pipes.md
rename to docs/docs-beta/docs/guides/pipes.md
diff --git a/docs/docs-beta/docs/guides/quality-testing.md b/docs/docs-beta/docs/guides/quality-testing.md
deleted file mode 100644
index 0c346fe97ee1f..0000000000000
--- a/docs/docs-beta/docs/guides/quality-testing.md
+++ /dev/null
@@ -1,3 +0,0 @@
----
-title: "Testing"
----
diff --git a/docs/docs-beta/docs/guides/resources.md b/docs/docs-beta/docs/guides/resources.md
new file mode 100644
index 0000000000000..da1f60335f974
--- /dev/null
+++ b/docs/docs-beta/docs/guides/resources.md
@@ -0,0 +1,6 @@
+---
+title: Using Resources to manage external systems
+sidebar_label: Resources
+---
+
+Dagster resources are objects that provide access to external systems, databases, or services. Resources are used to manage connections to external systems, and are used by Dagster ops and assets.
diff --git a/docs/docs-beta/docs/guides/tbd/running-local-ui-development.md b/docs/docs-beta/docs/guides/running-local-ui-development.md
similarity index 100%
rename from docs/docs-beta/docs/guides/tbd/running-local-ui-development.md
rename to docs/docs-beta/docs/guides/running-local-ui-development.md
diff --git a/docs/docs-beta/docs/guides/automation/schedules.md b/docs/docs-beta/docs/guides/schedules.md
similarity index 95%
rename from docs/docs-beta/docs/guides/automation/schedules.md
rename to docs/docs-beta/docs/guides/schedules.md
index f7e57c68cd7dc..a2e0c9f4be614 100644
--- a/docs/docs-beta/docs/guides/automation/schedules.md
+++ b/docs/docs-beta/docs/guides/schedules.md
@@ -1,6 +1,6 @@
---
title: "Schedule cron-based pipelines"
-sidebar_label: "Run pipelines on a schedule"
+sidebar_label: "Schedules"
sidebar_position: 10
---
@@ -59,7 +59,7 @@ partitioned_op_schedule = build_schedule_from_partitioned_job(
## Next steps
- Learn more about schedules in [Understanding Automation](/concepts/automation)
-- React to events with [sensors](/guides/automation/sensors)
+- React to events with [sensors](/guides/sensors)
- Explore [Declarative Automation](/concepts/automation/declarative-automation) as an alternative to schedules
By understanding and effectively using these automation methods, you can build more efficient data pipelines that respond to your specific needs and constraints.
diff --git a/docs/docs-beta/docs/guides/deployment/secrets.md b/docs/docs-beta/docs/guides/secrets.md
similarity index 100%
rename from docs/docs-beta/docs/guides/deployment/secrets.md
rename to docs/docs-beta/docs/guides/secrets.md
diff --git a/docs/docs-beta/docs/guides/tbd/selection-syntax.md b/docs/docs-beta/docs/guides/selection-syntax.md
similarity index 100%
rename from docs/docs-beta/docs/guides/tbd/selection-syntax.md
rename to docs/docs-beta/docs/guides/selection-syntax.md
diff --git a/docs/docs-beta/docs/guides/deployment/self-hosted-to-dagster-plus.md b/docs/docs-beta/docs/guides/self-hosted-to-dagster-plus.md
similarity index 100%
rename from docs/docs-beta/docs/guides/deployment/self-hosted-to-dagster-plus.md
rename to docs/docs-beta/docs/guides/self-hosted-to-dagster-plus.md
diff --git a/docs/docs-beta/docs/guides/automation/sensors.md b/docs/docs-beta/docs/guides/sensors.md
similarity index 96%
rename from docs/docs-beta/docs/guides/automation/sensors.md
rename to docs/docs-beta/docs/guides/sensors.md
index 41bdf1136c4d7..17a8030a09290 100644
--- a/docs/docs-beta/docs/guides/automation/sensors.md
+++ b/docs/docs-beta/docs/guides/sensors.md
@@ -1,6 +1,6 @@
---
title: Create event-based pipelines with sensors
-sidebar_label: Create event-based pipelines
+sidebar_label: Sensors
sidebar_position: 20
---
diff --git a/docs/docs-beta/docs/guides/troubleshooting/some-guide.md b/docs/docs-beta/docs/guides/some-guide.md
similarity index 100%
rename from docs/docs-beta/docs/guides/troubleshooting/some-guide.md
rename to docs/docs-beta/docs/guides/some-guide.md
diff --git a/docs/docs-beta/docs/guides/tbd.md b/docs/docs-beta/docs/guides/tbd.md
deleted file mode 100644
index 2de204e4176c3..0000000000000
--- a/docs/docs-beta/docs/guides/tbd.md
+++ /dev/null
@@ -1,3 +0,0 @@
----
-title: TBD
----
\ No newline at end of file
diff --git a/docs/docs-beta/docs/guides/ingestion-transformation/transform-dbt.md b/docs/docs-beta/docs/guides/transform-dbt.md
similarity index 98%
rename from docs/docs-beta/docs/guides/ingestion-transformation/transform-dbt.md
rename to docs/docs-beta/docs/guides/transform-dbt.md
index fe0dcf88217e9..78c7c04131bcd 100644
--- a/docs/docs-beta/docs/guides/ingestion-transformation/transform-dbt.md
+++ b/docs/docs-beta/docs/guides/transform-dbt.md
@@ -1,6 +1,7 @@
---
title: Transforming data with dbt
sidebar_position: 20
+sidebar_label: Transform data with dbt
last_update:
date: 2024-08-26
author: Nick Roach
diff --git a/docs/docs-beta/docs/guides/troubleshooting.md b/docs/docs-beta/docs/guides/troubleshooting.md
deleted file mode 100644
index 6fe20e17f2943..0000000000000
--- a/docs/docs-beta/docs/guides/troubleshooting.md
+++ /dev/null
@@ -1,3 +0,0 @@
----
-title: Troubleshooting
----
\ No newline at end of file
diff --git a/docs/docs-beta/docs/guides/quality-testing/unit-tests-assets-and-ops.md b/docs/docs-beta/docs/guides/unit-tests-assets-and-ops.md
similarity index 100%
rename from docs/docs-beta/docs/guides/quality-testing/unit-tests-assets-and-ops.md
rename to docs/docs-beta/docs/guides/unit-tests-assets-and-ops.md
diff --git a/docs/docs-beta/docs/tutorial/installation.md b/docs/docs-beta/docs/tutorial/installation.md
new file mode 100644
index 0000000000000..11e5781960218
--- /dev/null
+++ b/docs/docs-beta/docs/tutorial/installation.md
@@ -0,0 +1,82 @@
+---
+title: "Dagster installation"
+description: "Learn how to install Dagster"
+---
+
+# Dagster installation
+
+This guide will walk you through the steps to install Dagster, a data orchestrator for machine learning, analytics, and ETL. Follow the instructions below to get started with Dagster on your local machine.
+
+
+ Prerequisites
+
+Before you begin, ensure you have the following prerequisites installed on your system:
+
+- Python 3.7 or higher, Python 3.11 is recommended
+- pip, a Python package installer
+
+
+
+## Set up a virtual environment
+
+After installing Python, it's a good idea to setup a virtual environment to isolate your Dagster project from the rest of your system.
+
+There are many ways to setup a virtual environment. One method that requires no
+additional dependencies is to use `venv`.
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+```
+
+`pyenv` and `pyenv-virtualenv` are more powerful tools that can help you manage multiple versions of Python on a single machine. You can learn more about them in the [pyenv GitHub repository](https://github.com/pyenv/pyenv).
+
+## Install Dagster
+
+To install Dagster in your virtual environment, open your terminal and run the following command:
+
+```bash
+pip install dagster dagster-webserver
+```
+
+This command will install the core Dagster library and the webserver, which is used to serve the Dagster UI.
+
+## Verify installation
+
+To verify that Dagster is installed correctly, you can run the following command:
+
+```bash
+dagster --version
+```
+
+You should see the version numbers of Dagster printed in the terminal.
+
+```bash
+> dagster --version
+dagster, version 1.7.6
+```
+
+If you see `dagster, version 1!0+dev`, then you have the development version of Dagster
+installed. You can choose to install the latest stable version by providing a version
+to the `pip install` command.
+
+For example, to install version 1.7.6, you can run:
+
+```bash
+pip install 'dagster==1.7.6'
+```
+
+## Conclusion
+
+Congratulations! You have successfully installed Dagster
+
+## Troubleshooting
+
+If you encounter any issues during the installation process, refer to the [Dagster GitHub repository](https://github.com/dagster-io/dagster) for troubleshooting or reach out to the Dagster community for further assistance.
+
+## Next steps
+
+- [Quickstart Tutorial](/tutorial/quick-start)
+- [ETL Tutorial](/tutorial/tutorial-etl)
+- [Create a new Dagster project](/tutorial/create-new-project)
+- [Creating Data Assets](/guides/data-assets)
diff --git a/docs/docs-beta/sidebars.ts b/docs/docs-beta/sidebars.ts
index 3736dd8131459..9a070ed2493b5 100644
--- a/docs/docs-beta/sidebars.ts
+++ b/docs/docs-beta/sidebars.ts
@@ -1,29 +1,11 @@
-import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
-
-/**
- * Creating a sidebar enables you to:
- - create an ordered group of docs
- - render a sidebar for each doc of that group
- - provide next/previous navigation
-
- The sidebars can be generated from the filesystem, or explicitly defined here.
-
- Create as many sidebars as you want.
- */
+import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
const sidebars: SidebarsConfig = {
- // By default, Docusaurus generates a sidebar from the docs folder structure
- // docSidebar: [{ type: "autogenerated", dirName: "." }],
docs: [
{
type: 'category',
label: 'Getting Started',
collapsed: false,
- items: [
- {
- type: 'autogenerated',
- dirName: 'getting-started',
- },
- ],
+ items: ['intro', 'getting-started/quickstart', 'tutorial/installation'],
},
{
type: 'category',
@@ -32,148 +14,82 @@ const sidebars: SidebarsConfig = {
},
{
type: 'category',
- label: 'Guides',
+ label: 'Build',
items: [
{
type: 'category',
- label: 'Data modeling',
- link: {
- type: 'doc',
- id: 'guides/data-modeling',
- },
+ label: 'Build a pipeline',
items: [
- {
- type: 'autogenerated',
- dirName: 'guides/data-modeling',
- },
- {
- type: 'doc',
- label: 'Structuring your project',
- id: 'guides/project-structure',
- },
+ 'guides/data-assets',
+ 'guides/metadata',
+ 'guides/partitioning',
+ 'guides/external-assets',
],
},
{
type: 'category',
- label: 'Ingestion and Transformation',
- link: {
- type: 'doc',
- id: 'guides/ingestion-transformation',
- },
- items: [
- {
- type: 'autogenerated',
- dirName: 'guides/ingestion-transformation',
- },
+ label: 'Configure',
+ items: ['guides/configuring-assets',
+ 'guides/asset-factories',
+ 'guides/resources',
+ 'guides/io-managers',
],
},
{
type: 'category',
- label: 'Automation and Scheduling',
- link: {
- type: 'doc',
- id: 'guides/automation',
- },
+ label: 'Integrate',
items: [
- {
- type: 'autogenerated',
- dirName: 'guides/automation',
- },
- ],
- },
- {
- type: 'category',
- label: 'Integrating with External Systems',
- link: {
- type: 'doc',
- id: 'guides/external-systems',
- },
- items: [
- {
- type: 'autogenerated',
- dirName: 'guides/external-systems',
- },
- ],
- },
- {
- type: 'category',
- label: 'Data Quality and Testing',
- link: {
- type: 'doc',
- id: 'guides/quality-testing',
- },
- items: [
- {
- type: 'autogenerated',
- dirName: 'guides/quality-testing',
- },
- ],
- },
- {
- type: 'category',
- label: 'Monitoring and Alerting',
- link: {
- type: 'doc',
- id: 'guides/monitor-alert',
- },
- items: [
- {
- type: 'autogenerated',
- dirName: 'guides/monitor-alert',
- },
- ],
- },
- {
- type: 'category',
- label: 'Deployment',
- link: {
- type: 'doc',
- id: 'guides/deployment',
- },
- items: [
- {
- type: 'autogenerated',
- dirName: 'guides/deployment',
- },
+ 'guides/ingesting-data',
+ 'guides/transform-dbt',
+ 'guides/non-python',
],
},
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Automate',
+ items: [
+ 'guides/schedules',
+ 'guides/sensors',
+ 'guides/asset-sensors',
+ 'guides/declarative-automation',
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Test',
+ items: [
+ 'guides/asset-checks',
+ 'guides/data-freshness-testing',
+ 'guides/unit-tests-assets-and-ops',
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Deploy',
+ items: [
{
type: 'category',
- label: 'Troubleshooting',
- link: {
- type: 'doc',
- id: 'guides/troubleshooting',
- },
- items: [
- {
- type: 'autogenerated',
- dirName: 'guides/troubleshooting',
- },
- ],
+ label: 'Self-hosting Dagster',
+ items: ['guides/kubernetes', 'guides/docker'],
},
{
type: 'category',
- label: 'TBD',
- items: [
- {
- type: 'autogenerated',
- dirName: 'guides/tbd',
- },
- ],
+ label: 'Dagster Plus',
+ items: ['guides/dagster-plus', 'guides/self-hosted-to-dagster-plus'],
},
+ 'guides/secrets',
+ 'guides/code-locations',
],
},
{
type: 'category',
- label: 'Concepts',
+ label: 'Understand',
items: [
{
type: 'category',
label: 'Assets',
- link: {
- type: 'doc',
- id: 'concepts/assets',
- },
items: [
{
type: 'autogenerated',
@@ -184,10 +100,6 @@ const sidebars: SidebarsConfig = {
{
type: 'category',
label: 'Automation and Scheduling',
- link: {
- type: 'doc',
- id: 'concepts/automation',
- },
items: [
{
type: 'autogenerated',
diff --git a/docs/docs-beta/src/components/Cards.tsx b/docs/docs-beta/src/components/Cards.tsx
index c0f9d28cbfdd9..9712ad4849ded 100644
--- a/docs/docs-beta/src/components/Cards.tsx
+++ b/docs/docs-beta/src/components/Cards.tsx
@@ -1,6 +1,6 @@
import React from 'react';
import Link from '@docusaurus/Link';
-
+import Heading from '@theme/Heading';
interface CardProps {
title: string;
icon: string;
@@ -10,7 +10,7 @@ interface CardProps {
const Card: React.FC = ({title, icon, href, children}) => (
-