reorganize deployment docs

Signed-off-by: nikki everett <nikki@dagsterlabs.com>
dagster-io · Nov 23, 2024 · 116f01f · 116f01f
1 parent b7760e5
commit 116f01f
Show file tree

Hide file tree

Showing 27 changed files with 34 additions and 98 deletions.
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/code-locations/index.md b/docs/docs-beta/docs/dagster-plus/deployment/code-locations/index.md
@@ -1,6 +1,7 @@
 ---
 title: "Code locations"
 displayed_sidebar: "dagsterPlus"
+sidebar_position: 8
 ---
 
 # 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: 1
 ---
 
 Your Dagster project must meet a few requirements to run in Dagster+.

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/dagster-plus-settings.md b/docs/docs-beta/docs/dagster-plus/deployment/dagster-plus-settings.md
@@ -1,6 +1,7 @@
 ---
 title: "Dagster+ settings"
 unlisted: true
+sidebar_position: 5
 ---
 
 # Dagster+ settings
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/deployment-settings.md b/docs/docs-beta/docs/dagster-plus/deployment/deployment-settings.md
@@ -3,6 +3,7 @@ title: "Deployment settings"
 displayed_sidebar: "dagsterPlus"
 sidebar_label: "Deployment settings"
 unlisted: true
+sidebar_position: 6
 ---
 
 # 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,4 +1,5 @@
 ---
+title: Deployment types
 unlisted: true
 ---
 

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: 30
 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: 10
 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: 20
 sidebar_label: "Set with Dagster+ UI"
 ---
 

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/environment-variables/index.md b/docs/docs-beta/docs/dagster-plus/deployment/environment-variables/index.md
@@ -2,6 +2,7 @@
 title: "Environment variables"
 displayed_sidebar: "dagsterPlus"
 unlisted: true
+sidebar_position: 7
 ---
 
 # Environment variables
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
@@ -2,6 +2,6 @@
 title: "Amazon ECS agents (Existing VPC)"
 displayed_sidebar: "dagsterPlus"
 sidebar_position: 11
-sidebar_label: "Amazon ECS (existing)"
+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
@@ -2,6 +2,6 @@
 title: "Amazon ECS agents (New VPC)"
 displayed_sidebar: "dagsterPlus"
 sidebar_position: 10
-sidebar_label: "Amazon ECS (new)"
+sidebar_label: "Amazon ECS (New VPC)"
 unlisted: true
 ---
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/index.md b/docs/docs-beta/docs/dagster-plus/deployment/hybrid/agents/index.md
@@ -0,0 +1,4 @@
+---
+title: "Agents"
+displayed_sidebar: "dagsterPlus"
+---
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: 60
 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: 40
 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: 70
 sidebar_label: "Settings"
 unlisted: true
 ---

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/hybrid/index.md b/docs/docs-beta/docs/dagster-plus/deployment/hybrid/index.md
@@ -1,7 +1,7 @@
 ---
 title: "Hybrid deployment"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 2
+sidebar_position: 3
 ---
 
 # Hybrid deployment

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: 20
 unlisted: true
 ---
 

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/migration/index.md b/docs/docs-beta/docs/dagster-plus/deployment/migration/index.md
@@ -0,0 +1,4 @@
+---
+title: Migration
+sidebar_position: 4
+---
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: 10
 unlisted: true
 ---
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,7 +1,7 @@
 ---
 title: 'CI/CD in Serverless '
 displayed_sidebar: 'dagsterPlus'
-sidebar_position: 10
+sidebar_position: 30
 ---
 
 # CI/CD in Serverless

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: 40
 ---
 
 # Dagster+ Serverless IP addresses

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/serverless/index.md b/docs/docs-beta/docs/dagster-plus/deployment/serverless/index.md
@@ -1,7 +1,7 @@
 ---
 title: 'Serverless deployment'
 displayed_sidebar: 'dagsterPlus'
-sidebar_position: 1
+sidebar_position: 2
 ---
 
 # Serverless deployment

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/serverless/run-isolation.md b/docs/docs-beta/docs/dagster-plus/deployment/serverless/run-isolation.md
@@ -2,7 +2,7 @@
 title: 'Serverless run isolation'
 displayed_sidebar: 'dagsterPlus'
 sidebar_label: 'Run isolation'
-sidebar_position: 35
+sidebar_position: 20
 ---
 
 # Serverless run isolation

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/serverless/runtime-environment.md b/docs/docs-beta/docs/dagster-plus/deployment/serverless/runtime-environment.md
@@ -2,7 +2,7 @@
 title: 'Serverless runtime environment'
 displayed_sidebar: 'dagsterPlus'
 sidebar_label: 'Runtime environment'
-sidebar_position: 30
+sidebar_position: 10
 ---
 
 By default, Dagster+ Serverless will package your code as PEX files and deploys them on Docker images. Using PEX files significantly reduces the time to deploy since it does not require building a new Docker image and provisioning a new container for every code change. However you are able to customize the Serverless runtime environment in various ways:

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/serverless/security.md b/docs/docs-beta/docs/dagster-plus/deployment/serverless/security.md
@@ -1,7 +1,7 @@
 ---
 title: 'Security & data protection'
 displayed_sidebar: 'dagsterPlus'
-sidebar_position: 20
+sidebar_position: 50
 ---
 
 # Serverless security & data protection

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/serverless/transition-hybrid.md b/docs/docs-beta/docs/dagster-plus/deployment/serverless/transition-hybrid.md
@@ -1,7 +1,7 @@
 ---
 title: "Transitioning to Hybrid"
 displayed_sidebar: "dagsterPlus"
-sidebar_position: 50
+sidebar_position: 60
 ---
 
 After utilizing a Dagster+ [Serverless](/dagster-plus/deployment/serverless) deployment, you may decide to leverage your own infrastructure to execute your code. Transitioning to a Hybrid deployment requires only a few steps and can be done without any loss of execution history or metadata, allowing you to maintain continuity and control over your operations.

diff --git a/docs/docs-beta/sidebars.ts b/docs/docs-beta/sidebars.ts
@@ -404,86 +404,8 @@ const sidebars: SidebarsConfig = {
       collapsible: false,
       items: [
         {
-          type: 'category',
-          label: 'Serverless',
-          link: {
-            type: 'doc',
-            id: 'dagster-plus/deployment/serverless/index',
-          },
-          items: [
-            'dagster-plus/deployment/serverless/runtime-environment',
-            'dagster-plus/deployment/serverless/run-isolation',
-            'dagster-plus/deployment/serverless/ci-cd-in-serverless',
-            'dagster-plus/deployment/serverless/dagster-ips',
-            'dagster-plus/deployment/serverless/security',
-            'dagster-plus/deployment/serverless/transition-hybrid'
-          ],
-        },
-        {
-          type: 'category',
-          label: 'Hybrid',
-          link: {
-            type: 'doc',
-            id: 'dagster-plus/deployment/hybrid/index',
-          },
-          items: [
-            {
-              type: 'doc',
-              label: 'Tokens',
-              id: 'dagster-plus/deployment/hybrid/tokens',
-            },
-            {
-              type: 'category',
-              label: 'Agents',
-              items: [
-                {
-                  type: 'autogenerated',
-                  dirName: 'dagster-plus/deployment/hybrid/agents',
-                },
-              ],
-            },
-          ],
-        },
-        {
-          type: 'category',
-          label: 'Migration',
-          items: [
-              'dagster-plus/deployment/migration/self-hosted-to-dagster-plus'
-          ],
-        },
-        {
-          type: 'category',
-          label: 'Code locations',
-          link: {
-            type: 'doc',
-            id: 'dagster-plus/deployment/code-locations/index',
-          },
-          items: [
-            'dagster-plus/deployment/code-locations/code-location-history'
-          ],
-        },
-        {
-          type: 'category',
-          label: 'Environment variables',
-          link: {
-            type: 'doc',
-            id: 'dagster-plus/deployment/environment-variables/index',
-          },
-          items: [
-            'dagster-plus/deployment/environment-variables/built-in',
-            'dagster-plus/deployment/environment-variables/dagster-ui',
-            'dagster-plus/deployment/environment-variables/agent-config'
-          ],
-        },
-        {
-          type: 'doc',
-          label: 'Deployment settings',
-          id: 'dagster-plus/deployment/deployment-settings',
-        },
-        {
-          type: 'doc',
-          label: 'Dagster+ settings',
-          id: 'dagster-plus/deployment/dagster-plus-settings',
+          type: 'autogenerated',
+          dirName: 'dagster-plus/deployment'
         }
       ],
     },