[docs] [revamp] - Seed Concept pages (#23602)

## Summary & Motivation ## How I Tested These Changes --------- Co-authored-by: Pedram Navid <[email protected]>
dagster-io · Aug 13, 2024 · aa7cac7 · aa7cac7 · github-actions · Aug 13, 2024
1 parent a854606
commit aa7cac7
Show file tree

Hide file tree

Showing 25 changed files with 178 additions and 18 deletions.
diff --git a/.github/workflows/build-docs-revamp.yml b/.github/workflows/build-docs-revamp.yml
@@ -1,8 +1,6 @@
 name: Deploy Docs Revamp
 on:
   pull_request:
-    branches:
-      - docs/revamp
     paths:
       - docs/docs-next
       - .github/workflows/build-docs-revamp.yml
@@ -13,21 +11,21 @@ on:
     paths:
       - docs/docs-next
       - .github/workflows/build-docs-revamp.yml
+
 concurrency:
   # Cancel in-progress runs on same branch
-  group: ${{ github.ref }}
+  group: ${{ github.workflow}}-${{github.ref}}
   cancel-in-progress: true
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout docs/revamp branch
-        if: github.event_name == 'push' && github.ref == 'refs/heads/docs/revamp'
         uses: actions/checkout@v4
 
       - name: Publish Preview to Vercel
         uses: amondnet/vercel-action@v25
-        if: github.event_name == 'push' && github.ref == 'refs/heads/docs/revamp'
         with:
           github-comment: ${{ true }}
           vercel-token: ${{ secrets.VERCEL_TOKEN }}
@@ -36,4 +34,4 @@ jobs:
           vercel-args: "--prod"
           github-token: ${{ secrets.GITHUB_TOKEN }}
           scope: ${{ secrets.VERCEL_ORG_ID }}
-          alias-domains: dagster-docs-next.dagster.dagster-docs.io
+          alias-domains: dagster-docs-next.dagster.dagster-docs.io
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -18,7 +18,7 @@ on:
       - .github/workflows/build-docs.yml
 concurrency:
   # Cancel in-progress runs on same branch
-  group: ${{ github.ref }}
+  group: ${{ github.workflow}}-${{github.ref}}
   cancel-in-progress: true
 jobs:
   deploy:

diff --git a/...-next/docs/concepts/thinking-in-assets.md → docs/docs-next/docs/concepts/assets.md b/...-next/docs/concepts/thinking-in-assets.md → docs/docs-next/docs/concepts/assets.md
diff --git a/docs/docs-next/docs/concepts/assets/asset-checks.md b/docs/docs-next/docs/concepts/assets/asset-checks.md
@@ -0,0 +1,6 @@
+---
+title: "Asset checks"
+sidebar_position: 70
+---
+
+# Asset checks
diff --git a/docs/docs-next/docs/concepts/assets/asset-dependencies.md b/docs/docs-next/docs/concepts/assets/asset-dependencies.md
@@ -0,0 +1,6 @@
+---
+title: "Asset dependencies"
+sidebar_position: 30
+---
+
+# Asset dependencies
diff --git a/docs/docs-next/docs/concepts/assets/asset-materialization.md b/docs/docs-next/docs/concepts/assets/asset-materialization.md
@@ -0,0 +1,6 @@
+---
+title: "Asset materialization"
+sidebar_position: 20
+---
+
+# Asset materialization
diff --git a/docs/docs-next/docs/concepts/assets/asset-metadata.md b/docs/docs-next/docs/concepts/assets/asset-metadata.md
@@ -0,0 +1,6 @@
+---
+title: "Asset metadata"
+sidebar_position: 40
+---
+
+# Asset metadata
diff --git a/docs/docs-next/docs/concepts/assets/thinking-in-assets.md b/docs/docs-next/docs/concepts/assets/thinking-in-assets.md
@@ -0,0 +1,6 @@
+---
+title: "Thinking in assets"
+sidebar_position: 10
+---
+
+# Thinking in assets
diff --git a/docs/docs-next/docs/concepts/automation.md b/docs/docs-next/docs/concepts/automation.md
@@ -0,0 +1 @@
+# Automation
diff --git a/docs/docs-next/docs/concepts/automation/declarative-automation.md b/docs/docs-next/docs/concepts/automation/declarative-automation.md
@@ -0,0 +1,6 @@
+---
+title: "Declarative Automation"
+sidebar_position: 10
+---
+
+# Declarative Automation
diff --git a/docs/docs-next/docs/concepts/automation/schedules.md b/docs/docs-next/docs/concepts/automation/schedules.md
@@ -0,0 +1,6 @@
+---
+title: "Schedules"
+sidebar_position: 10
+---
+
+# Schedules
diff --git a/docs/docs-next/docs/concepts/automation/sensors.md b/docs/docs-next/docs/concepts/automation/sensors.md
@@ -0,0 +1,6 @@
+---
+title: "Sensors"
+sidebar_position: 20
+---
+
+# Sensors
diff --git a/docs/docs-next/docs/concepts/execution.md b/docs/docs-next/docs/concepts/execution.md
@@ -0,0 +1 @@
+# Execution
diff --git a/docs/docs-next/docs/concepts/execution/dagster-daemon.md b/docs/docs-next/docs/concepts/execution/dagster-daemon.md
@@ -0,0 +1,6 @@
+---
+title: "Dagster daemon"
+sidebar_position: 10
+---
+
+# Dagster daemon
diff --git a/docs/docs-next/docs/concepts/execution/run-coordinators.md b/docs/docs-next/docs/concepts/execution/run-coordinators.md
@@ -0,0 +1,6 @@
+---
+title: "Run coordinators"
+sidebar_position: 40
+---
+
+# Run coordinators
diff --git a/docs/docs-next/docs/concepts/execution/run-executors.md b/docs/docs-next/docs/concepts/execution/run-executors.md
@@ -0,0 +1,6 @@
+---
+title: "Run executors"
+sidebar_position: 30
+---
+
+# Run executors
diff --git a/docs/docs-next/docs/concepts/execution/run-launchers.md b/docs/docs-next/docs/concepts/execution/run-launchers.md
@@ -0,0 +1,6 @@
+---
+title: "Run launchers"
+sidebar_position: 20
+---
+
+# Run launchers
diff --git a/docs/docs-next/docs/concepts/io-managers.md b/docs/docs-next/docs/concepts/io-managers.md
@@ -0,0 +1,5 @@
+---
+title: "I/O managers"
+---
+
+# I/O managers
diff --git a/docs/docs-next/docs/concepts/ops-jobs.md b/docs/docs-next/docs/concepts/ops-jobs.md
@@ -0,0 +1 @@
+# Ops and jobs
diff --git a/docs/docs-next/docs/concepts/ops-jobs/job-configuration.md b/docs/docs-next/docs/concepts/ops-jobs/job-configuration.md
@@ -0,0 +1,6 @@
+---
+title: "Job configuration"
+sidebar_position: 10
+---
+
+# Job configuration
diff --git a/docs/docs-next/docs/concepts/ops-jobs/ops-vs-assets.md b/docs/docs-next/docs/concepts/ops-jobs/ops-vs-assets.md
@@ -0,0 +1,6 @@
+---
+title: "Ops vs. assets"
+sidebar_position: 10
+---
+
+# Ops vs. assets
diff --git a/docs/docs-next/docs/concepts/partitions.md b/docs/docs-next/docs/concepts/partitions.md
@@ -0,0 +1,5 @@
+---
+title: "Partitions"
+---
+
+# Partitions
diff --git a/docs/docs-next/docs/concepts/resources.md b/docs/docs-next/docs/concepts/resources.md
@@ -0,0 +1 @@
+# Resources
diff --git a/docs/docs-next/docs/tutorial/quick-start.md b/docs/docs-next/docs/tutorial/quick-start.md
@@ -168,4 +168,4 @@ Congratulations! You've just built and run your first pipeline with Dagster. You
 ## Next Steps
 
 - Continue with the [ETL Pipeline Tutorial](/tutorial/tutorial-etl) to learn how to build a more complex ETL pipeline
-- Learn how to [Think in Assets](/concepts/thinking-in-assets)
+- Learn how to [Think in Assets](/concepts/assets/thinking-in-assets)
diff --git a/docs/docs-next/sidebars.ts b/docs/docs-next/sidebars.ts
@@ -128,20 +128,84 @@ const sidebars: SidebarsConfig = {
         }
       ],
     },
-  ],
-
-  /*
-  // But you can create a sidebar manually
-  docSidebar: [
-    "intro",
-    "hello",
     {
       type: "category",
-      label: "Tutorial",
-      items: ["tutorial-basics/create-a-document"],
+      label: "Concepts",
+      items: [
+        {
+          type: "category",
+          label: "Assets",
+          link: {
+            type: "doc",
+            id: "concepts/assets"
+          },
+          items: [
+            {
+              type: 'autogenerated',
+              dirName: "concepts/assets"
+            },
+          ]
+        },
+        {
+          type: "category",
+          label: "Automation",
+          link: {
+            type: "doc",
+            id: "concepts/automation"
+          },
+          items: [
+            {
+              type: 'autogenerated',
+              dirName: "concepts/automation"
+            },
+          ]
+        },
+        {
+          type: "doc",
+          label: "Partitions",
+          id: "concepts/partitions",
+        },
+        {
+          type: "doc",
+          label: "Resources",
+          id: "concepts/resources",
+        },
+        {
+          type: "doc",
+          label: "I/O managers",
+          id: "concepts/io-managers",
+        },
+        {
+          type: "category",
+          label: "Ops and jobs",
+          link: {
+            type: "doc",
+            id: "concepts/ops-jobs"
+          },
+          items: [
+            {
+              type: 'autogenerated',
+              dirName: "concepts/ops-jobs"
+            },
+          ]
+        },
+        {
+          type: "category",
+          label: "Execution",
+          link: {
+            type: "doc",
+            id: "concepts/execution"
+          },
+          items: [
+            {
+              type: 'autogenerated',
+              dirName: "concepts/execution"
+            },
+          ]
+        }
+      ],
     },
   ],
-  */
 };
 
 export default sidebars;