From aa7cac7f668a90aa399c00a8309f7f66d29ad2cf Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Tue, 13 Aug 2024 13:16:50 -0400 Subject: [PATCH] [docs] [revamp] - Seed Concept pages (#23602) ## Summary & Motivation ## How I Tested These Changes --------- Co-authored-by: Pedram Navid <1045990+PedramNavid@users.noreply.github.com> --- .github/workflows/build-docs-revamp.yml | 10 +-- .github/workflows/build-docs.yml | 2 +- .../{thinking-in-assets.md => assets.md} | 0 .../docs/concepts/assets/asset-checks.md | 6 ++ .../concepts/assets/asset-dependencies.md | 6 ++ .../concepts/assets/asset-materialization.md | 6 ++ .../docs/concepts/assets/asset-metadata.md | 6 ++ .../concepts/assets/thinking-in-assets.md | 6 ++ docs/docs-next/docs/concepts/automation.md | 1 + .../automation/declarative-automation.md | 6 ++ .../docs/concepts/automation/schedules.md | 6 ++ .../docs/concepts/automation/sensors.md | 6 ++ docs/docs-next/docs/concepts/execution.md | 1 + .../docs/concepts/execution/dagster-daemon.md | 6 ++ .../concepts/execution/run-coordinators.md | 6 ++ .../docs/concepts/execution/run-executors.md | 6 ++ .../docs/concepts/execution/run-launchers.md | 6 ++ docs/docs-next/docs/concepts/io-managers.md | 5 ++ docs/docs-next/docs/concepts/ops-jobs.md | 1 + .../concepts/ops-jobs/job-configuration.md | 6 ++ .../docs/concepts/ops-jobs/ops-vs-assets.md | 6 ++ docs/docs-next/docs/concepts/partitions.md | 5 ++ docs/docs-next/docs/concepts/resources.md | 1 + docs/docs-next/docs/tutorial/quick-start.md | 2 +- docs/docs-next/sidebars.ts | 84 ++++++++++++++++--- 25 files changed, 178 insertions(+), 18 deletions(-) rename docs/docs-next/docs/concepts/{thinking-in-assets.md => assets.md} (100%) create mode 100644 docs/docs-next/docs/concepts/assets/asset-checks.md create mode 100644 docs/docs-next/docs/concepts/assets/asset-dependencies.md create mode 100644 docs/docs-next/docs/concepts/assets/asset-materialization.md create mode 100644 docs/docs-next/docs/concepts/assets/asset-metadata.md create mode 100644 docs/docs-next/docs/concepts/assets/thinking-in-assets.md create mode 100644 docs/docs-next/docs/concepts/automation.md create mode 100644 docs/docs-next/docs/concepts/automation/declarative-automation.md create mode 100644 docs/docs-next/docs/concepts/automation/schedules.md create mode 100644 docs/docs-next/docs/concepts/automation/sensors.md create mode 100644 docs/docs-next/docs/concepts/execution.md create mode 100644 docs/docs-next/docs/concepts/execution/dagster-daemon.md create mode 100644 docs/docs-next/docs/concepts/execution/run-coordinators.md create mode 100644 docs/docs-next/docs/concepts/execution/run-executors.md create mode 100644 docs/docs-next/docs/concepts/execution/run-launchers.md create mode 100644 docs/docs-next/docs/concepts/io-managers.md create mode 100644 docs/docs-next/docs/concepts/ops-jobs.md create mode 100644 docs/docs-next/docs/concepts/ops-jobs/job-configuration.md create mode 100644 docs/docs-next/docs/concepts/ops-jobs/ops-vs-assets.md create mode 100644 docs/docs-next/docs/concepts/partitions.md create mode 100644 docs/docs-next/docs/concepts/resources.md diff --git a/.github/workflows/build-docs-revamp.yml b/.github/workflows/build-docs-revamp.yml index 6a5ea0b7c0dc7..871ce662ddc07 100644 --- 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 \ No newline at end of file + alias-domains: dagster-docs-next.dagster.dagster-docs.io diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index a01a04f77172b..4bcecaf458b0b 100644 --- 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/docs/docs-next/docs/concepts/thinking-in-assets.md b/docs/docs-next/docs/concepts/assets.md similarity index 100% rename from docs/docs-next/docs/concepts/thinking-in-assets.md rename to 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 new file mode 100644 index 0000000000000..913b2c1a53ede --- /dev/null +++ b/docs/docs-next/docs/concepts/assets/asset-checks.md @@ -0,0 +1,6 @@ +--- +title: "Asset checks" +sidebar_position: 70 +--- + +# Asset checks \ No newline at end of file diff --git a/docs/docs-next/docs/concepts/assets/asset-dependencies.md b/docs/docs-next/docs/concepts/assets/asset-dependencies.md new file mode 100644 index 0000000000000..5c8105f20d7ba --- /dev/null +++ b/docs/docs-next/docs/concepts/assets/asset-dependencies.md @@ -0,0 +1,6 @@ +--- +title: "Asset dependencies" +sidebar_position: 30 +--- + +# Asset dependencies \ No newline at end of file diff --git a/docs/docs-next/docs/concepts/assets/asset-materialization.md b/docs/docs-next/docs/concepts/assets/asset-materialization.md new file mode 100644 index 0000000000000..fa5d0043d088f --- /dev/null +++ b/docs/docs-next/docs/concepts/assets/asset-materialization.md @@ -0,0 +1,6 @@ +--- +title: "Asset materialization" +sidebar_position: 20 +--- + +# Asset materialization \ No newline at end of file diff --git a/docs/docs-next/docs/concepts/assets/asset-metadata.md b/docs/docs-next/docs/concepts/assets/asset-metadata.md new file mode 100644 index 0000000000000..1681bcbf52686 --- /dev/null +++ b/docs/docs-next/docs/concepts/assets/asset-metadata.md @@ -0,0 +1,6 @@ +--- +title: "Asset metadata" +sidebar_position: 40 +--- + +# Asset metadata \ No newline at end of file diff --git a/docs/docs-next/docs/concepts/assets/thinking-in-assets.md b/docs/docs-next/docs/concepts/assets/thinking-in-assets.md new file mode 100644 index 0000000000000..78675fba1317b --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/docs-next/docs/concepts/automation.md b/docs/docs-next/docs/concepts/automation.md new file mode 100644 index 0000000000000..420e995b0d090 --- /dev/null +++ b/docs/docs-next/docs/concepts/automation.md @@ -0,0 +1 @@ +# Automation \ No newline at end of file diff --git a/docs/docs-next/docs/concepts/automation/declarative-automation.md b/docs/docs-next/docs/concepts/automation/declarative-automation.md new file mode 100644 index 0000000000000..60dc401e4168e --- /dev/null +++ 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 new file mode 100644 index 0000000000000..280d14cb0761f --- /dev/null +++ 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 new file mode 100644 index 0000000000000..d6b970d3fdd9c --- /dev/null +++ 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 new file mode 100644 index 0000000000000..b0301fd3fcea7 --- /dev/null +++ b/docs/docs-next/docs/concepts/execution.md @@ -0,0 +1 @@ +# Execution \ No newline at end of file diff --git a/docs/docs-next/docs/concepts/execution/dagster-daemon.md b/docs/docs-next/docs/concepts/execution/dagster-daemon.md new file mode 100644 index 0000000000000..ab685f8137253 --- /dev/null +++ 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 new file mode 100644 index 0000000000000..dd069fe237aac --- /dev/null +++ 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 new file mode 100644 index 0000000000000..993b5c37af4ab --- /dev/null +++ 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 new file mode 100644 index 0000000000000..c4096f6dd5beb --- /dev/null +++ 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 new file mode 100644 index 0000000000000..078ce80e62986 --- /dev/null +++ b/docs/docs-next/docs/concepts/io-managers.md @@ -0,0 +1,5 @@ +--- +title: "I/O managers" +--- + +# I/O managers \ No newline at end of file diff --git a/docs/docs-next/docs/concepts/ops-jobs.md b/docs/docs-next/docs/concepts/ops-jobs.md new file mode 100644 index 0000000000000..9dafc7edc1e32 --- /dev/null +++ b/docs/docs-next/docs/concepts/ops-jobs.md @@ -0,0 +1 @@ +# Ops and jobs \ No newline at end of file diff --git a/docs/docs-next/docs/concepts/ops-jobs/job-configuration.md b/docs/docs-next/docs/concepts/ops-jobs/job-configuration.md new file mode 100644 index 0000000000000..b250bbadbc04d --- /dev/null +++ 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 new file mode 100644 index 0000000000000..e887e8cc6e45f --- /dev/null +++ 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 new file mode 100644 index 0000000000000..e13a76656017f --- /dev/null +++ b/docs/docs-next/docs/concepts/partitions.md @@ -0,0 +1,5 @@ +--- +title: "Partitions" +--- + +# Partitions \ No newline at end of file diff --git a/docs/docs-next/docs/concepts/resources.md b/docs/docs-next/docs/concepts/resources.md new file mode 100644 index 0000000000000..54fed86a065a5 --- /dev/null +++ b/docs/docs-next/docs/concepts/resources.md @@ -0,0 +1 @@ +# Resources \ No newline at end of file diff --git a/docs/docs-next/docs/tutorial/quick-start.md b/docs/docs-next/docs/tutorial/quick-start.md index 6e71b987fd13b..f1edcb273879f 100644 --- 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) \ No newline at end of file +- Learn how to [Think in Assets](/concepts/assets/thinking-in-assets) \ No newline at end of file diff --git a/docs/docs-next/sidebars.ts b/docs/docs-next/sidebars.ts index fb9c0b3ff12b0..4e48637f87494 100644 --- 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;