[docs-beta] Update sidebar

dagster-io · Aug 21, 2024 · 46b8bc1 · 46b8bc1
1 parent e1745f3
commit 46b8bc1
Show file tree

Hide file tree

Showing 35 changed files with 148 additions and 25 deletions.
diff --git a/.github/workflows/build-docs-revamp.yml b/.github/workflows/build-docs-revamp.yml
@@ -42,4 +42,4 @@ jobs:
           vercel-args: "--prod"
           github-token: ${{ secrets.GITHUB_TOKEN }}
           scope: ${{ secrets.VERCEL_ORG_ID }}
-          alias-domains: dagster-docs-beta.dagster.dagster-docs.io
+          alias-domains: dagster-.dagster.dagster-docs.io
diff --git a/docs/docs-beta/.yarn/install-state.gz b/docs/docs-beta/.yarn/install-state.gz
diff --git a/docs/docs-beta/docs/guides/automation/configuring.md b/docs/docs-beta/docs/guides/automation/configuring.md
@@ -0,0 +1,5 @@
+---
+title: Configuring pipelines and runs
+sidebar_label: Configuring pipelines
+sidebar_position: 40
+---
diff --git a/...a-modeling/passing-data-between-assets.md → ...uides/data-modeling/asset-dependencies.md b/...a-modeling/passing-data-between-assets.md → ...uides/data-modeling/asset-dependencies.md
diff --git a/docs/docs-beta/docs/guides/data-modeling/configuring-assets.md b/docs/docs-beta/docs/guides/data-modeling/configuring-assets.md
@@ -0,0 +1,5 @@
+---
+title: Configuring assets and ops
+sidebar_label: Configuring assets
+sidebar_position: 50
+---
diff --git a/docs/docs-beta/docs/guides/data-modeling/creating-asset-factories.md b/docs/docs-beta/docs/guides/data-modeling/creating-asset-factories.md
@@ -1,4 +1,5 @@
 ---
-title: "Create asset factories"
-sidebar_position: 50
+title: "Creating asset factories"
+sidebar_position: 60
+sidebar_label: "Creating asset factories"
 ---
diff --git a/docs/docs-beta/docs/guides/data-modeling/external-assets.md b/docs/docs-beta/docs/guides/data-modeling/external-assets.md
@@ -0,0 +1,5 @@
+---
+title: Representing external data sources with external assets
+sidebar_position: 80
+sidebar_label: "Representing external data sources"
+---
diff --git a/docs/docs-beta/docs/guides/data-modeling/metadata.md b/docs/docs-beta/docs/guides/data-modeling/metadata.md
@@ -0,0 +1,6 @@
+---
+title: "Adding metadata and tags to assets"
+description: "Learn how to add metadata and tags to assets to improve observability in Dagster"
+sidebar_position: 40
+sidebar_label: "Enriching assets with metadata"
+---
diff --git a/docs/docs-beta/docs/guides/data-modeling/partitioning.md b/docs/docs-beta/docs/guides/data-modeling/partitioning.md
@@ -0,0 +1,6 @@
+---
+title: How to Partition Your Data
+description: Learn how to partition your data in Dagster.
+sidebar_label: Partitioning pipelines
+sidebar_position: 30
+---
diff --git a/docs/docs-beta/docs/guides/data-modeling/selecting-subsets-of-assets.md b/docs/docs-beta/docs/guides/data-modeling/selecting-subsets-of-assets.md
@@ -1,5 +1,5 @@
 ---
-title: "Select subsets of assets"
-sidebar_position: 60
-sidebar_label: "Select assets"
+title: "Selecting subsets of assets"
+sidebar_position: 70
+sidebar_label: "Selecting assets"
 ---
diff --git a/docs/docs-beta/docs/guides/deployment/managing-code-locations.md b/docs/docs-beta/docs/guides/deployment/managing-code-locations.md
@@ -1,6 +1,7 @@
 ---
-title: "Manage code locations"
+title: "Managing code locations with Definitions"
 sidebar_position: 50
+sidebar_label: "Code locations and Definitions"
 ---
 
 # Manage code locations
diff --git a/docs/docs-beta/docs/guides/deployment/secrets.md b/docs/docs-beta/docs/guides/deployment/secrets.md
@@ -0,0 +1,4 @@
+---
+title: Managing secrets
+sidebar_position: 50
+---
diff --git a/docs/docs-beta/docs/guides/ingestion.md → docs/docs-beta/docs/guides/etl.md b/docs/docs-beta/docs/guides/ingestion.md → docs/docs-beta/docs/guides/etl.md
diff --git a/docs/docs-beta/docs/guides/etl/backfill.md b/docs/docs-beta/docs/guides/etl/backfill.md
@@ -0,0 +1,5 @@
+---
+title: Backfilling data
+sidebar_position: 60
+sidebar_label: "Backfilling"
+---
diff --git a/docs/docs-beta/docs/guides/etl/dbt.md b/docs/docs-beta/docs/guides/etl/dbt.md
@@ -0,0 +1,4 @@
+---
+title: Transforming data with dbt
+sidebar_position: 20
+---
diff --git a/docs/docs-beta/docs/guides/etl/incremental-loading.md b/docs/docs-beta/docs/guides/etl/incremental-loading.md
@@ -0,0 +1,6 @@
+---
+title: Incrementally loading data 
+description: How to use partitions to incrementally load data with Dagster
+sidebar_label: Incremental loading
+sidebar_position: 50
+---
diff --git a/docs/docs-beta/docs/guides/etl/ingesting-data.md b/docs/docs-beta/docs/guides/etl/ingesting-data.md
@@ -0,0 +1,6 @@
+---
+title: Ingesting data with Dagster
+description: Learn how to ingest data into Dagster using embedded-elt
+sidebar_position: 10
+sidebar_label: Ingesting data
+---
diff --git a/docs/docs-beta/docs/guides/etl/transform-python.md b/docs/docs-beta/docs/guides/etl/transform-python.md
@@ -0,0 +1,4 @@
+---
+title: Transform data with Python
+sidebar_position: 40
+---
diff --git a/docs/docs-beta/docs/guides/external-systems/apis.md b/docs/docs-beta/docs/guides/external-systems/apis.md
@@ -0,0 +1,4 @@
+---
+title: Connecting to APIs
+sidebar_position: 20
+---
diff --git a/docs/docs-beta/docs/guides/external-systems/cloud.md b/docs/docs-beta/docs/guides/external-systems/cloud.md
@@ -0,0 +1,4 @@
+---
+title: Connecting to cloud services
+sidebar_position: 25
+---
diff --git a/docs/docs-beta/docs/guides/external-systems/databases.md b/docs/docs-beta/docs/guides/external-systems/databases.md
@@ -0,0 +1,4 @@
+---
+title: Connecting to databases
+sidebar_position: 10
+---
diff --git a/docs/docs-beta/docs/guides/external-systems/iomanagers.md b/docs/docs-beta/docs/guides/external-systems/iomanagers.md
@@ -0,0 +1,5 @@
+---
+title: "Managing stored data with I/O Managers"
+sidebar_position: 50
+sidebar_label: "Storing data with I/O Managers"
+---
diff --git a/docs/docs-beta/docs/guides/external-systems/pipes.md b/docs/docs-beta/docs/guides/external-systems/pipes.md
@@ -0,0 +1,5 @@
+---
+title: "Excuting code outside of Dagster with Pipes"
+sidebar_position: 40
+sidebar_label: "External execution with Pipes"
+---
diff --git a/docs/docs-beta/docs/guides/external-systems/resources.md b/docs/docs-beta/docs/guides/external-systems/resources.md
@@ -0,0 +1,5 @@
+---
+title: "Using Resources to Connect with External Systems"
+sidebar_position: 30
+sidebar_label: "Managing connections with resources"
+---
diff --git a/docs/docs-beta/docs/guides/monitoring/alerting.md b/docs/docs-beta/docs/guides/monitoring/alerting.md
@@ -0,0 +1,12 @@
+---
+title: "Setting up alerts"
+sidebar_position: 30
+sidebar_label: "Alerting"
+---
+
+Alerting if my pipeline didn't execute
+Tracking when a run or sensor fails
+Knowing when a pipeline never ran
+Knowing if a pipeline is running slow, or an asset is late
+Knowing if my Dagster instance is having issues
+
diff --git a/docs/docs-beta/docs/guides/monitoring/custom-logging.md b/docs/docs-beta/docs/guides/monitoring/custom-logging.md
@@ -1,4 +1,6 @@
 ---
-title: "Set up custom logging"
-sidebar_position: 10
----
+title: "Setting up custom logging"
+sidebar_position: 20
+---
+
+# Setting up custom logging
diff --git a/docs/docs-beta/docs/guides/testing.md → .../docs-beta/docs/guides/quality-testing.md b/docs/docs-beta/docs/guides/testing.md → .../docs-beta/docs/guides/quality-testing.md
diff --git a/docs/docs-beta/docs/guides/quality-testing/integration-tests.md b/docs/docs-beta/docs/guides/quality-testing/integration-tests.md
@@ -0,0 +1,4 @@
+---
+title: "Integration testing"
+sidebar_position: 40
+---
diff --git a/...sting/testing-assets-with-asset-checks.md → ...sting/testing-assets-with-asset-checks.md b/...sting/testing-assets-with-asset-checks.md → ...sting/testing-assets-with-asset-checks.md
diff --git a/...des/testing/testing-for-data-freshness.md → ...ity-testing/testing-for-data-freshness.md b/...des/testing/testing-for-data-freshness.md → ...ity-testing/testing-for-data-freshness.md
diff --git a/docs/docs-beta/docs/guides/quality-testing/unit-tests-for-assets-and-ops.md b/docs/docs-beta/docs/guides/quality-testing/unit-tests-for-assets-and-ops.md
@@ -0,0 +1,7 @@
+---
+title: "Unit tests for assets and ops"
+sidebar_position: 30
+sidebar_label: "Unit testing"
+---
+
+# Unit tests for assets and ops
diff --git a/docs/docs-beta/docs/guides/testing/unit-tests-for-assets-and-ops.md b/docs/docs-beta/docs/guides/testing/unit-tests-for-assets-and-ops.md
diff --git a/docs/docs-beta/docs/guides/troubleshooting.md b/docs/docs-beta/docs/guides/troubleshooting.md
@@ -0,0 +1,3 @@
+---
+title: Troubleshooting
+---
diff --git a/docs/docs-beta/docs/guides/troubleshooting/some-guide.md b/docs/docs-beta/docs/guides/troubleshooting/some-guide.md
diff --git a/docs/docs-beta/sidebars.ts b/docs/docs-beta/sidebars.ts
@@ -1,4 +1,4 @@
-import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
+import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
 
 /**
  * Creating a sidebar enables you to:
@@ -44,21 +44,21 @@ const sidebars: SidebarsConfig = {
         },
         {
           type: 'category',
-          label: 'Transformation',
+          label: 'Ingestion and Transformation',
           link: {
             type: 'doc',
-            id: 'guides/transformation',
+            id: 'guides/etl',
           },
           items: [
             {
               type: 'autogenerated',
-              dirName: 'guides/transformation',
+              dirName: 'guides/etl',
             },
           ],
         },
         {
           type: 'category',
-          label: 'Automation',
+          label: 'Automation and Scheduling',
           link: {
             type: 'doc',
             id: 'guides/automation',
@@ -72,7 +72,7 @@ const sidebars: SidebarsConfig = {
         },
         {
           type: 'category',
-          label: 'External systems',
+          label: 'Integrating with External Systems',
           link: {
             type: 'doc',
             id: 'guides/external-systems',
@@ -86,21 +86,21 @@ const sidebars: SidebarsConfig = {
         },
         {
           type: 'category',
-          label: 'Testing',
+          label: 'Data Quality and Testing',
           link: {
             type: 'doc',
-            id: 'guides/testing',
+            id: 'guides/quality-testing',
           },
           items: [
             {
               type: 'autogenerated',
-              dirName: 'guides/testing',
+              dirName: 'guides/quality-testing',
             },
           ],
         },
         {
           type: 'category',
-          label: 'Monitoring',
+          label: 'Monitoring and Alerting',
           link: {
             type: 'doc',
             id: 'guides/monitoring',
@@ -126,6 +126,20 @@ const sidebars: SidebarsConfig = {
             },
           ],
         },
+        {
+          type: 'category',
+          label: 'Troubleshooting',
+          link: {
+            type: 'doc',
+            id: 'guides/troubleshooting',
+          },
+          items: [
+            {
+              type: 'autogenerated',
+              dirName: 'guides/troubleshooting',
+            },
+          ],
+        },
       ],
     },
     {
@@ -148,7 +162,7 @@ const sidebars: SidebarsConfig = {
         },
         {
           type: 'category',
-          label: 'Automation',
+          label: 'Automation and Scheduling',
           link: {
             type: 'doc',
             id: 'concepts/automation',