[docs] [revamp] - Vale updates (#23758)

## Summary & Motivation This PR addresses comments in #23754 ## How I Tested These Changes
dagster-io · Aug 20, 2024 · 137ed67 · 137ed67
1 parent 75b334e
commit 137ed67
Show file tree

Hide file tree

Showing 64 changed files with 203 additions and 217 deletions.
diff --git a/docs/docs-beta/docs/concepts/assets.md b/docs/docs-beta/docs/concepts/assets.md
@@ -4,6 +4,6 @@ title: Assets
 
 # Assets
 
-## Assets and Ops
+## Assets and ops
 
 Assets and ops are two different concepts in Dagster.
diff --git a/docs/docs-beta/docs/concepts/assets/thinking-in-assets.md b/docs/docs-beta/docs/concepts/assets/thinking-in-assets.md
@@ -1,6 +1,6 @@
 ---
-title: "Thinking in assets"
+title: "Think in assets"
 sidebar_position: 10
 ---
 
-# Thinking in assets
+# Think in assets
diff --git a/docs/docs-beta/docs/concepts/io-managers.md b/docs/docs-beta/docs/concepts/io-managers.md
@@ -1,5 +1,3 @@
-## =======
-
-## title: "I/O managers"
-
-# I/O managers
+---
+title: "I/O managers"
+---
diff --git a/docs/docs-beta/docs/concepts/understanding-assets.md b/docs/docs-beta/docs/concepts/understanding-assets.md
@@ -1,5 +1,5 @@
 ---
-title: Understanding Assets
+title: About assets
 description: Understanding the concept of assets in Dagster
 last_update:
   date: 2024-08-11

diff --git a/docs/docs-beta/docs/dagster-plus/access/rbac/teams.md b/docs/docs-beta/docs/dagster-plus/access/rbac/teams.md
@@ -1,7 +1,7 @@
 ---
-title: "Managing teams"
+title: "Team management"
 displayed_sidebar: "dagsterPlus"
 sidebar_position: 2
 ---
 
-# Managing teams
+# Team management in Dagster+
diff --git a/docs/docs-beta/docs/dagster-plus/access/rbac/users.md b/docs/docs-beta/docs/dagster-plus/access/rbac/users.md
@@ -1,7 +1,7 @@
 ---
-title: "Managing users"
+title: "User management"
 displayed_sidebar: "dagsterPlus"
 sidebar_position: 1
 ---
 
-# Managing users
+# User management in Dagster+
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/alerts.md b/docs/docs-beta/docs/dagster-plus/deployment/alerts.md
@@ -2,4 +2,4 @@
 title: "Dagster+ alerts"
 ---
 
-# DAgster+ alerts
+# Dagster+ alerts
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
@@ -1,8 +1,8 @@
 ---
-title: "Branch Deployment Change Tracking"
+title: "Change Tracking in Branch Deployments"
 displayed_sidebar: "dagsterPlus"
 sidebar_position: 4
 sidebar_label: "Change Tracking"
 ---
 
-# Using Change Tracking
+# Change Tracking in Branch Deployments
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
@@ -5,4 +5,4 @@ sidebar_position: 3
 sidebar_label: "dagster-cloud CLI"
 ---
 
-# Using Branch Deployments with the dagster-cloud CLI
+# Use Branch Deployments with the dagster-cloud CLI
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/branch-deployments/github.md b/docs/docs-beta/docs/dagster-plus/deployment/branch-deployments/github.md
@@ -5,4 +5,4 @@ sidebar_position: 1
 sidebar_label: "GitHub"
 ---
 
-# Using Branch Deployments with GitHub
+# Use Branch Deployments with GitHub
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/branch-deployments/gitlab.md b/docs/docs-beta/docs/dagster-plus/deployment/branch-deployments/gitlab.md
@@ -5,4 +5,4 @@ sidebar_position: 2
 sidebar_label: "Gitlab"
 ---
 
-# Using Branch Deployments with Gitlab
+# Use Branch Deployments with Gitlab
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,8 +1,8 @@
 ---
-title: "Setting environment variables using agent config"
+title: "Set environment variables using agent config"
 displayed_sidebar: "dagsterPlus"
 sidebar_position: 2
 sidebar_label: "Set with agent config"
 ---
 
-# Setting environment variables using agent config
+# Set environment variables using agent config
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,8 +1,8 @@
 ---
-title: "Setting environment variables with the Dagster+ UI"
+title: "Set environment variables with the Dagster+ UI"
 displayed_sidebar: "dagsterPlus"
 sidebar_position: 1
 sidebar_label: "Set with Dagster+ UI"
 ---
 
-# Setting environment variables with the Dagster+ UI
+# Set environment variables with the Dagster+ UI
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
@@ -4,4 +4,4 @@ displayed_sidebar: "dagsterPlus"
 sidebar_position: 50
 ---
 
-# Using multiple agents
+# Use multiple agents with Dagster+
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
@@ -4,4 +4,4 @@ displayed_sidebar: "dagsterPlus"
 sidebar_position: 50
 ---
 
-# Transitioning from Serverless to Hybrid
+# Transition from Serverless to Hybrid
diff --git a/docs/docs-beta/docs/dagster-plus/getting-started.md b/docs/docs-beta/docs/dagster-plus/getting-started.md
@@ -3,4 +3,4 @@ title: "Getting started with Dagster+"
 displayed_sidebar: "dagsterPlus"
 ---
 
-# Getting started with Dagster+
+# Get started with Dagster+
diff --git a/docs/docs-beta/docs/dagster-plus/insights/asset-metadata.md b/docs/docs-beta/docs/dagster-plus/insights/asset-metadata.md
@@ -1,7 +1,7 @@
 ---
-title: "Integrating asset metadata into Dagster+ Insights"
+title: "Integrate asset metadata into Dagster+ Insights"
 sidebar_label: "Integrate asset metadata"
 sidebar_position: 1
 ---
 
-# Integrating asset metadata into Dagster+ Insights
+# Integrate asset metadata into Dagster+ Insights
diff --git a/docs/docs-beta/docs/dagster-plus/insights/export-metrics.md b/docs/docs-beta/docs/dagster-plus/insights/export-metrics.md
@@ -1,7 +1,7 @@
 ---
-title: "Exporting metrics from Dagster+ Insights"
+title: "Export metrics from Dagster+ Insights"
 sidebar_label: "Export metrics"
 sidebar_position: 6
 ---
 
-# xporting metrics from Dagster+ Insights
+# Export metrics from Dagster+ Insights
diff --git a/docs/docs-beta/docs/guides/automation.md b/docs/docs-beta/docs/guides/automation.md
@@ -57,7 +57,6 @@ You must provide a function that the sensor will use to determine if it should t
 
 Like schedules, sensors operate on a selection of assets, known as [Jobs](/concepts/ops-jobs) and can either start a pipeline through a Run or log a reason for not starting a pipeline using a SkipReason.
 
-
 ### When to use sensors
 
 - You need event-driven automation
@@ -78,7 +77,7 @@ Asset Sensors trigger jobs when specified assets are materialized, allowing you
 
 For more examples of how to create asset sensors, see the [How-To Use Asset Sensors](/guides/automation/asset-sensors) guide.
 
-## Declarative automation
+## Declarative Automation
 
 TODO: add content
 

diff --git a/docs/docs-beta/docs/guides/automation/asset-sensors.md b/docs/docs-beta/docs/guides/automation/asset-sensors.md
@@ -1,10 +1,8 @@
 ---
-title: Triggering jobs with Asset Sensors
-sidebar_label: Triggering jobs with Asset Sensors
+title: Trigger jobs with Asset Sensors
 sidebar_position: 30
 ---
 
-
 Asset sensors in Dagster provide a powerful mechanism for monitoring asset materializations and triggering downstream computations or notifications based on those events.
 
 This guide covers the most common use cases for asset sensors such as defining cross-job and cross-code location dependencies.
@@ -74,7 +72,7 @@ otherwise it skips the run.
 
 ## Trigger a job with configuration
 
-By providing a configuration to the `RunRequest` object, you can trigger a job with a specific configuration. This is useful when you want to trigger a job with custom parameters based on custom logic you define. For example, you might use a sensor to trigger a job when an asset is materialized, but also pass metadata about that materialization to the job. 
+By providing a configuration to the `RunRequest` object, you can trigger a job with a specific configuration. This is useful when you want to trigger a job with custom parameters based on custom logic you define. For example, you might use a sensor to trigger a job when an asset is materialized, but also pass metadata about that materialization to the job.
 
 <CodeExample filePath="guides/automation/asset-sensor-with-config.py" language="python" title="Asset Sensor with Config" />
 

diff --git a/docs/docs-beta/docs/guides/automation/schedules.md b/docs/docs-beta/docs/guides/automation/schedules.md
@@ -1,6 +1,6 @@
 ---
-title: "Scheduling cron-based pipelines"
-sidebar_label: "Running pipelines on a schedule"
+title: "Schedule cron-based pipelines"
+sidebar_label: "Run pipelines on a schedule"
 sidebar_position: 10
 ---
 
@@ -26,7 +26,7 @@ By default, schedules without a timezone will run in Coordinated Universal Time
 ```python
 daily_schedule = ScheduleDefinition(
     job=daily_refresh_job,
-    cron_schedule="0 0 * * *", 
+    cron_schedule="0 0 * * *",
     timezone="America/Los_Angeles",
 )
 ```

diff --git a/docs/docs-beta/docs/guides/automation/sensors.md b/docs/docs-beta/docs/guides/automation/sensors.md
@@ -1,13 +1,13 @@
 ---
-title: Creating event-based pipelines with sensors
-sidebar_label: Creating event-based pipelines
+title: Create event-based pipelines with sensors
+sidebar_label: Create event-based pipelines
 sidebar_position: 20
-
 ---
+
 Sensors are a way to trigger runs in response to events in Dagster. Sensors
 run on a regular interval and can either trigger a run, or provide a reason why a run was skipped.
 
-Sensors allow you to react events in external systems. For example, you can trigger a run when a new file arrives in an S3 bucket, or when a row is updated in a database.
+Sensors allow you to respond to events in external systems. For example, you can trigger a run when a new file arrives in an S3 bucket, or when a row is updated in a database.
 
 <details>
 <summary>Prerequisites</summary>

diff --git a/docs/docs-beta/docs/guides/data-modeling.md b/docs/docs-beta/docs/guides/data-modeling.md
@@ -1,8 +1,8 @@
 ---
-title: "Modeling your data"
+title: "Model your data"
 ---
 
-# Modeling your data
+# Model your data
 
 - Data Assets
 - Partitions

diff --git a/docs/docs-beta/docs/guides/data-modeling/adding-metadata-to-assets.md b/docs/docs-beta/docs/guides/data-modeling/adding-metadata-to-assets.md
@@ -1,5 +1,5 @@
 ---
-title: "Adding metadata to assets"
+title: "Add metadata to assets"
 sidebar_position: 40
-sidebar_label: "Adding metadata"
+sidebar_label: "Add metadata"
 ---
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,5 +1,4 @@
 ---
-title: "Creating asset factories"
+title: "Create asset factories"
 sidebar_position: 50
-sidebar_label: "Creating asset factories"
 ---
diff --git a/docs/docs-beta/docs/guides/data-modeling/creating-data-assets.md b/docs/docs-beta/docs/guides/data-modeling/creating-data-assets.md
@@ -1,5 +1,4 @@
 ---
-title: "Creating data assets"
+title: "Create data assets"
 sidebar_position: 10
-sidebar_label: "Creating data assets"
 ---
diff --git a/docs/docs-beta/docs/guides/data-modeling/creating-dependencies-between-assets.md b/docs/docs-beta/docs/guides/data-modeling/creating-dependencies-between-assets.md
@@ -1,5 +1,5 @@
 ---
-title: "Creating dependencies between assets"
+title: "Create dependencies between assets"
 sidebar_position: 20
-sidebar_label: "Creating asset dependencies"
+sidebar_label: "Create asset dependencies"
 ---