Reorganize new Dagster+ docs (#26067)

Merge this PR, then merge #26019. ## Summary & Motivation Reorganizes docs in /dagster-plus to make it easier to port content from old docs. See #26019 for a more detailed description of the motivation -- many of the changes here are similar to changes in that PR. ## How I Tested These Changes Tested locally. ## Changelog > Insert changelog entry or delete this section. --------- Signed-off-by: nikki everett <[email protected]> Co-authored-by: colton <[email protected]>
dagster-io · Dec 3, 2024 · d41107b · d41107b
1 parent 34c723a
commit d41107b
Show file tree

Hide file tree

Showing 109 changed files with 436 additions and 556 deletions.
diff --git a/docs/docs-beta/docs/dagster-plus.md b/docs/docs-beta/docs/dagster-plus.md
diff --git a/docs/docs-beta/docs/dagster-plus/access/authentication/scim-provisioning.md b/docs/docs-beta/docs/dagster-plus/access/authentication/scim-provisioning.md
diff --git a/docs/docs-beta/docs/dagster-plus/access/rbac.md b/docs/docs-beta/docs/dagster-plus/access/rbac.md
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/branch-deployments.md b/docs/docs-beta/docs/dagster-plus/deployment/branch-deployments.md
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/branch-deployments/change-tracking.md b/docs/docs-beta/docs/dagster-plus/deployment/branch-deployments/change-tracking.md
diff --git a/.../docs-beta/docs/dagster-plus/deployment/branch-deployments/dagster-cloud-cli.md b/.../docs-beta/docs/dagster-plus/deployment/branch-deployments/dagster-cloud-cli.md
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/branch-deployments/testing.md b/docs/docs-beta/docs/dagster-plus/deployment/branch-deployments/testing.md
diff --git a/.../docs-beta/docs/dagster-plus/deployment/code-locations/code-location-history.md b/.../docs-beta/docs/dagster-plus/deployment/code-locations/code-location-history.md
@@ -1,7 +1,7 @@
 ---
 title: "Code location history and rollbacks"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 4
+sidebar_position: 100
 sidebar_label: "Code location history and rollbacks"
 ---
 
@@ -54,4 +54,4 @@ If you notice an issue with newly deployed code, or your code fails to deploy su
 ## Next steps
 
 - Learn more about [Code Locations](/dagster-plus/deployment/code-locations)
-- Learn how to [Alert when a code location fails to load](/dagster-plus/deployment/alerts#alerting-when-a-code-location-fails-to-load)
+- Learn how to [Alert when a code location fails to load](/dagster-plus/features/alerts#alerting-when-a-code-location-fails-to-load)
diff --git a/...dagster-plus/deployment/code-locations.md → ...r-plus/deployment/code-locations/index.md b/...dagster-plus/deployment/code-locations.md → ...r-plus/deployment/code-locations/index.md
@@ -1,6 +1,7 @@
 ---
 title: "Code locations"
 displayed_sidebar: "dagsterPlus"
+sidebar_position: 50
 ---
 
 # Code locations

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/code-requirements.md b/docs/docs-beta/docs/dagster-plus/deployment/code-requirements.md
@@ -2,6 +2,7 @@
 title: 'Dagster+ code requirements'
 displayed_sidebar: 'dagsterPlus'
 sidebar_label: "Code requirements"
+sidebar_position: 100
 ---
 
 Your Dagster project must meet a few requirements to run in Dagster+.

diff --git a/docs/docs-beta/docs/dagster-plus/settings.md → ...-plus/deployment/dagster-plus-settings.md b/docs/docs-beta/docs/dagster-plus/settings.md → ...-plus/deployment/dagster-plus-settings.md
@@ -1,6 +1,7 @@
 ---
 title: "Dagster+ settings"
 unlisted: true
+sidebar_position: 200
 ---
 
 # Dagster+ settings
diff --git a/.../docs/dagster-plus/deployment/settings.md → ...er-plus/deployment/deployment-settings.md b/.../docs/dagster-plus/deployment/settings.md → ...er-plus/deployment/deployment-settings.md
@@ -1,8 +1,9 @@
 ---
 title: "Deployment settings"
 displayed_sidebar: "dagsterPlus"
-sidebar_label: "Settings"
+sidebar_label: "Deployment settings"
 unlisted: true
+sidebar_position: 300
 ---
 
 # Deployment settings
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/deployment-types.md b/docs/docs-beta/docs/dagster-plus/deployment/deployment-types.md
@@ -1,5 +1,7 @@
 ---
+title: Deployment types
 unlisted: true
+sidebar_position: 400
 ---
 
-## Placeholder
+# Deployment types
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/environment-variables/agent-config.md b/docs/docs-beta/docs/dagster-plus/deployment/environment-variables/agent-config.md
@@ -1,7 +1,7 @@
 ---
 title: "Set environment variables using agent config"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 2
+sidebar_position: 300
 sidebar_label: "Set with agent config"
 unlisted: true
 ---

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/environment-variables/built-in.md b/docs/docs-beta/docs/dagster-plus/deployment/environment-variables/built-in.md
@@ -1,7 +1,7 @@
 ---
 title: "Built-in environment variables"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 3
+sidebar_position: 100
 sidebar_label: "Built-in variables"
 ---
 

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/environment-variables/dagster-ui.md b/docs/docs-beta/docs/dagster-plus/deployment/environment-variables/dagster-ui.md
@@ -1,7 +1,7 @@
 ---
 title: "Setting environment variables with the Dagster+ UI"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 1
+sidebar_position: 200
 sidebar_label: "Set with Dagster+ UI"
 ---
 

diff --git a/...-plus/deployment/environment-variables.md → ...eployment/environment-variables/index.mdx b/...-plus/deployment/environment-variables.md → ...eployment/environment-variables/index.mdx
@@ -2,6 +2,11 @@
 title: "Environment variables"
 displayed_sidebar: "dagsterPlus"
 unlisted: true
+sidebar_position: 40
 ---
 
 # Environment variables
+
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />
diff --git a/...docs-beta/docs/dagster-plus/deployment/hybrid/agents/amazon-ecs-existing-vpc.md b/...docs-beta/docs/dagster-plus/deployment/hybrid/agents/amazon-ecs-existing-vpc.md
@@ -1,7 +1,7 @@
 ---
 title: "Amazon ECS agents (Existing VPC)"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 11
-sidebar_label: "Amazon ECS (existing)"
+sidebar_position: 110
+sidebar_label: "Amazon ECS (Existing VPC)"
 unlisted: true
 ---
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/amazon-ecs-new-vpc.md b/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/amazon-ecs-new-vpc.md
@@ -1,7 +1,7 @@
 ---
 title: "Amazon ECS agents (New VPC)"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 10
-sidebar_label: "Amazon ECS (new)"
+sidebar_position: 100
+sidebar_label: "Amazon ECS (New VPC)"
 unlisted: true
 ---
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/docker.md b/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/docker.md
@@ -1,7 +1,7 @@
 ---
 title: "Docker agents"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 20
+sidebar_position: 200
 sidebar_label: "Docker"
 unlisted: true
 ---

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/index.mdx b/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/index.mdx
@@ -0,0 +1,11 @@
+---
+title: "Agents"
+displayed_sidebar: "dagsterPlus"
+sidebar_class_name: hidden
+---
+
+# Agents
+
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/kubernetes.md b/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/kubernetes.md
@@ -1,7 +1,7 @@
 ---
 title: "Running Dagster+ agents on Kubernetes"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 30
+sidebar_position: 300
 sidebar_label: "Kubernetes"
 ---
 
@@ -95,7 +95,7 @@ An exhaustive list of settings is available [here](/dagster-plus/deployment/hybr
 
 ### Configure your agents to serve branch deployments
 
-[Branch deployments](/dagster-plus/deployment/branch-deployments) are lightweight staging environments created for each code change. To configure your Dagster+ agent to manage them:
+[Branch deployments](/dagster-plus/features/branch-deployments/index.mdx) are lightweight staging environments created for each code change. To configure your Dagster+ agent to manage them:
 
 ```yaml
 # values.yaml

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/local.md b/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/local.md
@@ -1,7 +1,7 @@
 ---
 title: "Running a Dagster+ agent locally"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 40
+sidebar_position: 600
 sidebar_label: "Local"
 ---
 

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/multiple.md b/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/multiple.md
@@ -1,7 +1,7 @@
 ---
 title: "Using multiple agents"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 50
+sidebar_position: 400
 unlisted: true
 ---
 

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/settings.md b/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/settings.md
@@ -1,7 +1,7 @@
 ---
 title: "Hybrid agent settings"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 60
+sidebar_position: 700
 sidebar_label: "Settings"
 unlisted: true
 ---

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/hybrid/architecture.md b/docs/docs-beta/docs/dagster-plus/deployment/hybrid/architecture.md
@@ -1,7 +1,7 @@
 ---
 title: 'Dagster+ Hybrid architecture'
 displayed_sidebar: 'dagsterPlus'
-sidebar_position: 10
+sidebar_position: 100
 ---
 
 # Dagster+ Hybrid architecture

diff --git a/...ta/docs/dagster-plus/deployment/hybrid.md → ...s/dagster-plus/deployment/hybrid/index.md b/...ta/docs/dagster-plus/deployment/hybrid.md → ...s/dagster-plus/deployment/hybrid/index.md
@@ -1,7 +1,7 @@
 ---
 title: "Hybrid deployment"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 2
+sidebar_position: 20
 ---
 
 # Hybrid deployment
@@ -40,7 +40,7 @@ When you inform Dagster+ about a new code location, we enqueue instructions for
 
 ### Runs
 
-Your definitions might include [automations](/guides/automation) that launch runs or materialize assets. Or your developers might launch runs directly with the web UI.
+Your definitions might include [automations](/guides/automate) that launch runs or materialize assets. Or your developers might launch runs directly with the web UI.
 
 When a run needs to be launched, Dagster+ enqueues instructions for your agent to launch a new run. The next time your agent polls Dagster+ for new work, it will see instructions about how to launch your run. It will delegate those instructions to your code server and your code server will launch a run - a new run will typically require its own container.
 

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/hybrid/tokens.md b/docs/docs-beta/docs/dagster-plus/deployment/hybrid/tokens.md
@@ -1,7 +1,7 @@
 ---
 title: 'Hybrid agent tokens'
 displayed_sidebar: 'dagsterPlus'
-sidebar_position: 30
+sidebar_position: 200
 unlisted: true
 ---
 

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/migration/index.mdx b/docs/docs-beta/docs/dagster-plus/deployment/migration/index.mdx
@@ -0,0 +1,11 @@
+---
+title: Migration
+displayed_sidebar: "dagsterPlus"
+sidebar_position: 30
+---
+
+# Migration
+
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />
diff --git a/...docs-beta/docs/dagster-plus/deployment/migration/self-hosted-to-dagster-plus.md b/...docs-beta/docs/dagster-plus/deployment/migration/self-hosted-to-dagster-plus.md
@@ -1,5 +1,5 @@
 ---
 title: "Migrate from self-hosted to Dagster+"
-sidebar_position: 70
+sidebar_position: 100
 unlisted: true
 ---
diff --git a/...s-beta/docs/dagster-plus/multi-tenancy.md → .../dagster-plus/deployment/multi-tenancy.md b/...s-beta/docs/dagster-plus/multi-tenancy.md → .../dagster-plus/deployment/multi-tenancy.md
@@ -1,6 +1,7 @@
 ---
 title: "Multi-tenancy"
 unlisted: true
+sidebar_position: 500
 ---
 
 # Dagster+ multi-tenancy
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/serverless/ci-cd-in-serverless.md b/docs/docs-beta/docs/dagster-plus/deployment/serverless/ci-cd-in-serverless.md
@@ -1,17 +1,17 @@
 ---
 title: 'CI/CD in Serverless '
 displayed_sidebar: 'dagsterPlus'
-sidebar_position: 10
+sidebar_position: 300
 ---
 
 # CI/CD in Serverless
 
-If you're a GitHub or GitLab user, you can use our predefined workflows to seamlessly deploy and synchronize your code to Dagster+. You can also use other Git providers or a local Git repository with our [dagster-cloud CLI](/dagster-plus/deployment/branch-deployments/dagster-cloud-cli) to run your own CI/CD process.
+If you're a GitHub or GitLab user, you can use our predefined workflows to seamlessly deploy and synchronize your code to Dagster+. You can also use other Git providers or a local Git repository with our [dagster-cloud CLI](/dagster-plus/features/branch-deployments/dagster-cloud-cli) to run your own CI/CD process.
 
 <Tabs groupId="method">
 <TabItem value="GitHub" label="With GitHub">
 
-If you're a GitHub user, with a single click our GitHub app with GitHub Actions can set up a repo containing skeleton code and configuration for you consistent with Dagster+'s best practices. Pushing your code changes to the `main` branch will automatically deploy them to your `prod` Serverless deployment. Pull requests will spin up ephemeral [branch deployments](/dagster-plus/deployment/branch-deployments) that you can view in the Dagster+ UI for previewing and testing.
+If you're a GitHub user, with a single click our GitHub app with GitHub Actions can set up a repo containing skeleton code and configuration for you consistent with Dagster+'s best practices. Pushing your code changes to the `main` branch will automatically deploy them to your `prod` Serverless deployment. Pull requests will spin up ephemeral [branch deployments](/dagster-plus/features/branch-deployments/index.mdx) that you can view in the Dagster+ UI for previewing and testing.
 
 :::note
 **If you are importing a Dagster project that's in an existing GitHub repo:**
@@ -28,13 +28,13 @@ If you're a GitHub user, with a single click our GitHub app with GitHub Actions
 
 <TabItem value="GitLab" label="With GitLab">
 
-If you're a GitLab user, with a single click our GitLab app can set up a repo containing skeleton code and CI/CD configuration for you consistent with Dagster+'s best practices. Pushing your code changes to the `main` branch will automatically deploy them to your `prod` Serverless deployment. Pull requests will spin up ephemeral [branch deployments](/dagster-plus/deployment/branch-deployments) that you can view in the Dagster+ UI for previewing and testing.
+If you're a GitLab user, with a single click our GitLab app can set up a repo containing skeleton code and CI/CD configuration for you consistent with Dagster+'s best practices. Pushing your code changes to the `main` branch will automatically deploy them to your `prod` Serverless deployment. Pull requests will spin up ephemeral [branch deployments](/dagster-plus/features/branch-deployments/index.mdx) that you can view in the Dagster+ UI for previewing and testing.
 
 </TabItem>
 
 <TabItem value="Other" label="Other Git providers or local development">
 
-If you don't want to use our automated GitHub/GitLab process, we offer [the powerful `dagster-cloud` command-line interface (CLI)](/dagster-plus/deployment/branch-deployments/dagster-cloud-cli) that you can use in another CI environment or locally.
+If you don't want to use our automated GitHub/GitLab process, we offer [the powerful `dagster-cloud` command-line interface (CLI)](/dagster-plus/features/branch-deployments/dagster-cloud-cli) that you can use in another CI environment or locally.
 
 First, [create a new project](/getting-started/quickstart) with the Dagster open source CLI.
 
@@ -62,7 +62,7 @@ install_requires=[
 
 :::
 
-Next, install the [`dagster-cloud` CLI](/dagster-plus/deployment/branch-deployments/dagster-cloud-cli) and use its `configure` command to authenticate it to your Dagster+ organization.
+Next, install the [`dagster-cloud` CLI](/dagster-plus/features/branch-deployments/dagster-cloud-cli) and use its `configure` command to authenticate it to your Dagster+ organization.
 
 **Note:** The CLI requires a recent version of Python 3 and Docker.
 
@@ -71,7 +71,7 @@ pip install dagster-cloud
 dagster-cloud configure
 ```
 
-You can also configure the `dagster-cloud` tool non-interactively; see [the CLI docs](/dagster-plus/deployment/branch-deployments/dagster-cloud-cli) for more information.
+You can also configure the `dagster-cloud` tool non-interactively; see [the CLI docs](/dagster-plus/features/branch-deployments/dagster-cloud-cli) for more information.
 
 Finally, deploy your project to Dagster+ using the `serverless` command:
 

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/serverless/dagster-ips.md b/docs/docs-beta/docs/dagster-plus/deployment/serverless/dagster-ips.md
@@ -1,7 +1,7 @@
 ---
 title: 'IP addresses'
 displayed_sidebar: 'dagsterPlus'
-sidebar_position: 50
+sidebar_position: 400
 ---
 
 # Dagster+ Serverless IP addresses

diff --git a/...ocs/dagster-plus/deployment/serverless.md → ...gster-plus/deployment/serverless/index.md b/...ocs/dagster-plus/deployment/serverless.md → ...gster-plus/deployment/serverless/index.md
@@ -1,7 +1,7 @@
 ---
 title: 'Serverless deployment'
 displayed_sidebar: 'dagsterPlus'
-sidebar_position: 1
+sidebar_position: 10
 ---
 
 # Serverless deployment