Skip to content

Commit

Permalink
[docs-beta] rm "what you'll learn" from content templates (#24413)
Browse files Browse the repository at this point in the history
## Summary & Motivation

## How I Tested These Changes

## Changelog

NOCHANGELOG
  • Loading branch information
cmpadden authored Sep 12, 2024
1 parent 5eab1c4 commit 839c545
Show file tree
Hide file tree
Showing 26 changed files with 1 addition and 172 deletions.
6 changes: 0 additions & 6 deletions docs/docs-beta/content-templates/guide-no-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@ description: 'Description of the guide, useful for SEO and social media links'
Provide a brief introduction to the how-to guide. View [this article](https://diataxis.fr/how-to-guides/) for more information on how to write effective how-to guides. The intro should be no more than a few sentences.
The title from the frontmatter will be used as the first heading in the guide, you don't need to include it in the intro.

## What you'll learn

- A thing you'll learn, ex: "How to generate a token"
- Another thing you'll learn, ex: "How to install this library"
- One more thing you'll learn

<details>
<summary>Prerequisites</summary>

Expand Down
6 changes: 0 additions & 6 deletions docs/docs-beta/content-templates/guide-with-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@ description: 'Description of the guide that is useful for SEO and social media l
Provide a brief introduction to the how-to guide. View [this article](https://diataxis.fr/how-to-guides/) for more information on how to write effective how-to guides. The intro should be no more than a few sentences.
The title from the frontmatter will be used as the first heading in the guide, you don't need to include it in the intro.

## What you'll learn

- A thing you'll learn, ex: "How to generate a token"
- Another thing you'll learn, ex: "How to install this library"
- One more thing you'll learn

<details>
<summary>Prerequisites</summary>

Expand Down
7 changes: 1 addition & 6 deletions docs/docs-beta/docs/dagster-plus/access/rbac/teams.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ sidebar_position: 2

As part of [role-based access control (RBAC)](/dagster-plus/access/rbac/user-roles-permissions), Dagster+ supports the ability to assign users to teams. A team is a group of users with a set of default deployment, code location, and Branch Deployment user roles.

## What you'll learn

- How to add, modify, and remove teams
- How to assign roles to teams

<details>
<summary>Prerequisites</summary>

Expand Down Expand Up @@ -80,4 +75,4 @@ Navigate to the **Organization Settings > Teams** tab and locate the team you wa
## Next steps

- Learn more about RBAC in [Understanding User Roles & Permissions](/dagster-plus/access/rbac/user-roles-permissions)
- Learn more about how to manage users in Dagster+ in [Understanding User Management in Dagster+](/dagster-plus/access/rbac/users)
- Learn more about how to manage users in Dagster+ in [Understanding User Management in Dagster+](/dagster-plus/access/rbac/users)
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@ toc_max_heading_level: 2

In this guide, we'll walk you through setting up Branch Deployments for a code location. Once you're finished, any time a PR is created or updated in your repository, it will automatically create or update an associated branch deployment in Dagster+.

## What you'll learn

- How to create a Dagster+ agent token
- How to configure a Dagster+ agent
- How to create and automate branch deployments for a repository

<details>
<summary>Prerequisites</summary>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@ sidebar_label: "Code location history and rollbacks"

Dagster+ automatically tracks metadata every time a code location is loaded. This can be used to understand when changes have been made, and what those changes were. In addition, this metadata can be used to quickly redeploy an older version.

## What you'll learn

- How to view code location history
- How to roll back a code location to a previous version
- How to navigate the code location page in the Dagster UI

<details>
<summary>Prerequisites</summary>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,6 @@ Environment variable are key-value pairs that are set outside of your source cod

Dagster supports several approaches for [accessing environment variable in your code](/todo). You can also set environment variables in several ways, but this guide will focus on the Dagster+ UI.

## What you'll learn

- How to add, edit, and delete environment variables in the Dagster+ UI
- How to view the values of environment variables in the Dagster+ UI
- How to export environment variables for local use
- How to modify the value of environment variables based on the deployment environment

<details>
<summary>Prerequisites</summary>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,6 @@ Local agents aren't well suited for most production use cases. If you're running
- You're alerted if the VM or container dies, or to automatically restart it
:::

## What you'll learn

- How to generate an agent token
- How to configure the local agent
- How to run the agent and confirm the setup was successful

<details>
<summary>Prerequisites</summary>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,6 @@ sidebar_position: 10

The Hybrid architecture is the most flexible and secure way to deploy Dagster+. It allows you to run your user code in your environment while leveraging Dagster+'s infrastructure for orchestration and metadata management

## What you'll learn

- Overall architecture of a Hybrid deployment
- The security implications of a Hybrid deployment

---

<details>
<summary>Pre-requisites</summary>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,6 @@ sidebar_position: 40

Dagster+ Serverless offers two settings for run isolation: isolated and non-isolated. Isolated runs are the default and are intended for production, while non-isolated runs are intended for faster iteration during development.

## What you'll learn

- The differences between isolated runs and non-isolated runs
- How to enable non-isolated runs
- How to adjust your deployment settings to run multiple non-isolated runs concurrently

---

<details>
<summary>Prerequisites</summary>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@ After utilizing a Dagster+ [Serverless](/dagster-plus/deployment/serverless) dep
Transitioning from Serverless to Hybrid requires some downtime, as your Dagster+ deployment won't have an agent to execute user code.
:::

## What you'll learn

- How to deactivate your Serverless agent
- How to create a Hybrid agent
- How to confirm that the Hybrid agent was set up successfully

<details>
<summary>Prerequisites</summary>

Expand Down
4 changes: 0 additions & 4 deletions docs/docs-beta/docs/dagster-plus/insights/asset-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ Out of the box, Dagster+ Insights gives you visibility into a variety of common
By creating custom metrics from asset metadata, you can use Insights to perform historical aggregation on any
data your assets can emit.

## What you'll learn

- How to add asset metadata as a custom metric to Dagster+ Insights

<details>
<summary>Prerequisites</summary>

Expand Down
8 changes: 0 additions & 8 deletions docs/docs-beta/docs/guides/apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,6 @@ sidebar_position: 20

When building a data pipeline, you'll likely need to connect to several external APIs, each with its own specific configuration and behavior. This guide demonstrates how to standardize your API connections and customize their configuration using Dagster resources.


## What you'll learn

- How to connect to an API using a Dagster resource
- How to use that resource in an asset
- How to configure a resource
- How to source configuration values from environment variables

<details>
<summary>Prerequisites</summary>

Expand Down
7 changes: 0 additions & 7 deletions docs/docs-beta/docs/guides/asset-factories-with-deps.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,6 @@ Additionally, you may be serving stakeholders who aren't familiar with Python or

Using an asset factory reduces complexity and creates a pluggable entry point to define additional assets.

## What you'll learn

- Programmatically defining dependencies using an asset factory
- How to define dependencies between factory assets and regular assets

---

<details>
<summary>Prerequisites</summary>

Expand Down
8 changes: 0 additions & 8 deletions docs/docs-beta/docs/guides/asset-factories.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,6 @@ Additionally, you may be serving stakeholders who aren't familiar with Python or

The asset factory pattern can solve both of these problems.

## What you'll learn

- Building an asset factory in Python
- Driving your asset factory with YAML
- Improving usability with Pydantic and Jinja

---

<details>
<summary>Prerequisites</summary>

Expand Down
6 changes: 0 additions & 6 deletions docs/docs-beta/docs/guides/automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@ last_update:

Automation is key to building reliable, efficient data pipelines. This guide provides a simplified overview of the main ways to automate processes in Dagster, helping you choose the right method for your needs. You will find links to more detailed guides for each method below.

## What you'll learn

- The different automation options available in Dagster
- How to implement basic scheduling and event-based triggers
- Best practices for selecting and using automation methods

<details>
<summary>Prerequisites</summary>

Expand Down
7 changes: 0 additions & 7 deletions docs/docs-beta/docs/guides/configuring-assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,6 @@ You will commonly want to manually materialize assets using the Dagster UI to ba

Often, you will want to be able to tweak some parameters when materializing these assets. This can be accomplished through the asset configuration system.

## What you'll learn

- How to make your assets configurable
- How to provide configuration when launching a run

---

<details>
<summary>Prerequisites</summary>

Expand Down
7 changes: 0 additions & 7 deletions docs/docs-beta/docs/guides/custom-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,10 @@ title: "Setting up custom logging"
sidebar_position: 20
---


# Custom loggers

Custom loggers are used to alter the structure of the logs being produced by your Dagster pipelines. For example, JSON logs can be produced to more easily be processed by log management systems.


## What you'll learn

- How to write a custom logger
- How to configure your jobs to use this custom logger

<details>
<summary>Prerequisites</summary>

Expand Down
6 changes: 0 additions & 6 deletions docs/docs-beta/docs/guides/databases.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@ sidebar_position: 10

In Dagster, *resources* are used to connect to databases by acting as a wrapper around database clients. The resource is registered along with connection details in the `Definitions` object, and can then be referenced from your asset definitions.

## What you'll learn

- How to connect to and query a local DuckDB database using the `DuckDBResource`
- How to connect to different databases in different environments, such as development and production.
- How to connect to a Snowflake database using the `SnowflakeResource`

<details>
<summary>Prerequisites</summary>

Expand Down
6 changes: 0 additions & 6 deletions docs/docs-beta/docs/guides/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@ description: A guide to deploying Dagster with Docker Compose.

This guide provides instructions for deploying Dagster using Docker Compose. This is useful when you want to, for example, deploy Dagster on an AWS EC2 host. A typical Dagster Docker deployment includes a several long-running containers: one for the webserver, one for the daemon, and one for each code location. It also typically executes each run in its own container.

## What you'll learn

- The different Docker containers that run as part of a Dagster Docker deployment
- How to define Docker images for each of these containers
- How to write a Docker Compose file that stands up these containers

<details>
<summary>Prerequisites</summary>
- Familiarity with Docker and Docker Compose
Expand Down
6 changes: 0 additions & 6 deletions docs/docs-beta/docs/guides/ingesting-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ This guide covers how to use Dagster for data ingestion.
This guide focuses on batch data ingestion, as streaming data ingestion doesn't typically rely on an orchestrator to kick off or coordinate computations. However, streaming data assets can still be represented in Dagster for lineage purposes.
:::

## What you'll learn

- How Dagster helps with data ingestion
- How to integrate Dagster with different data ingestion tools
- How to write custom data ingestion pipelines

<details>
<summary>Prerequisites</summary>
- Familiarity with [Assets](/concepts/assets)
Expand Down
7 changes: 0 additions & 7 deletions docs/docs-beta/docs/guides/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,6 @@ This guide will walk you through how to run the Dagster-specific components of a

Dagster provides [Helm charts](https://github.com/dagster-io/dagster/tree/master/helm) for deploying Dagster that you can customize for your specific needs. For each Dagster component used by the Helm chart, Dagster publishes a corresponding image to [DockerHub](https://hub.docker.com/u/dagster).

## What you'll learn

- How to build a Docker image containing your Dagster project to deploy to your cluster
- How to access and customize the Dagster-provided Helm charts
- How to apply the configuration in the Helm charts to your Kubernetes cluster to deploy your Dagster project
- How to connect to your deployed Dagster project

<details>
<summary>Prerequisites</summary>

Expand Down
9 changes: 0 additions & 9 deletions docs/docs-beta/docs/guides/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,6 @@ Assets feature prominently in the Dagster UI. It's often helpful to attach infor

In Dagster, you can attach ownership information, organize your assets with tags, attach rich, complex information with metadata, and link your assets with their source code.

## What you'll learn

- How to add owners to your assets
- How to use tags to organize assets
- How to attach complex information to an asset using metadata
- How to link your assets with their source code

---

<details>
<summary>Prerequisites</summary>

Expand Down
8 changes: 0 additions & 8 deletions docs/docs-beta/docs/guides/partitioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,6 @@ There are several ways to partition your data in Dagster:
- [Two-dimensional partitioning](#two-dimensional-partitions), for partitioning data along two different axes simultaneously
- [Dynamic partitioning](#dynamic-partitions), for creating partitions based on runtime information

## What you'll learn

- How to define partitions for Dagster assets and jobs
- How to establish dependencies between partitioned assets
- How to leverage Dagster partitions with external systems like dbt

---

<details>
<summary>Prerequisites</summary>

Expand Down
7 changes: 0 additions & 7 deletions docs/docs-beta/docs/guides/pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,6 @@ description: "Learn how to create data pipelines using Dagster's asset-based app

In Dagster, data pipelines are created using an asset-based approach. This overview will introduce you to the key concepts and steps involved in building a Dagster pipeline.

## What you'll learn

- The basics of Dagster's asset-based pipelines
- How to define and connect data assets
- Ways to enhance your pipeline with metadata and partitioning
- How to integrate external data sources

<details>
<summary>Prerequisites</summary>

Expand Down
6 changes: 0 additions & 6 deletions docs/docs-beta/docs/guides/project-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@ Refer to the project scaffolding tutorial to learn how to create a new Dagster p

There are many ways to structure your Dagster project, and it can be difficult to know where to start. In this guide, we will walk you through our recommendations for how to organize your Dagster project. As your project grows, you are welcome to deviate from these recommendations.

## What you'll learn

- How to restructure your project as your code base grows
- How to combine multiple `Definitions` objects using `Definitions.merge`
- How to integrate external projects like dbt or Sling into your codebase

## Your initial project structure

When you first scaffold your project using the Dagster command-line tool, an `assets.py` and `definitions.py` are created in the root of your project.
Expand Down
6 changes: 0 additions & 6 deletions docs/docs-beta/docs/guides/transform-dbt.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@ last_update:

Dagster orchestrates dbt alongside other technologies, so you can schedule dbt with Spark, Python, etc. in a single data pipeline. Dagster's asset-oriented approach allows Dagster to understand dbt at the level of individual dbt models.

## What you'll learn

- How to import a basic dbt project into Dagster
- How to set upstream and downstream dependencies on non-dbt assets
- How to schedule your dbt assets

<details>
<summary>Prerequisites</summary>

Expand Down

0 comments on commit 839c545

Please sign in to comment.