Skip to content

Commit

Permalink
[components] [docs] Initial components guide
Browse files Browse the repository at this point in the history
  • Loading branch information
smackesey committed Dec 20, 2024
1 parent 8d466fd commit 5f72d64
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/docs-beta/docs/guides/build/components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: "Dagster Components basics"
sidebar_position: 200
---

Welcome to Dagster Components.

Dagster Components is a new way to structure your Dagster projects. It aims to provide:

- An opinionated project layout that supports ongoing scaffolding from “Hello world” to the most advanced projects

Check warning on line 10 in docs/docs-beta/docs/guides/build/components.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Dagster.chars-non-standard-quotes] Use standard single quotes or double quotes only. Do not use left or right quotes. Raw Output: {"message": "[Dagster.chars-non-standard-quotes] Use standard single quotes or double quotes only. Do not use left or right quotes.", "location": {"path": "docs/docs-beta/docs/guides/build/components.md", "range": {"start": {"line": 10, "column": 72}}}, "severity": "WARNING"}

Check warning on line 10 in docs/docs-beta/docs/guides/build/components.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Dagster.chars-non-standard-quotes] Use standard single quotes or double quotes only. Do not use left or right quotes. Raw Output: {"message": "[Dagster.chars-non-standard-quotes] Use standard single quotes or double quotes only. Do not use left or right quotes.", "location": {"path": "docs/docs-beta/docs/guides/build/components.md", "range": {"start": {"line": 10, "column": 84}}}, "severity": "WARNING"}
- A class-based interface for dynamically constructing definitions
- A toolkit to build YAML DSL frontends for components so that components can be constructed in a low-code fashion.
- A format for components to provide their own scaffolding, in order to organize and reference integration-specific artifacts files.

Check warning on line 13 in docs/docs-beta/docs/guides/build/components.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Terms.words] Use 'to' instead of 'in order to'. Raw Output: {"message": "[Terms.words] Use 'to' instead of 'in order to'.", "location": {"path": "docs/docs-beta/docs/guides/build/components.md", "range": {"start": {"line": 13, "column": 61}}}, "severity": "WARNING"}

## Project Setup

```bash
brew install uv && uv tool install dagster-dg
```

```bash
dg generate code-location jaffle_platform
```

```bash
find jaffle_platform
```

```bash
jaffle_platform
# .env # TODO hypothesized
jaffle_platform/
lib/ # project-specific component library
components/ # all components live in here
jaffle_platform_tests/
```

## Hello Platform

We are going to effortlessly setup a data platform using sling to ingest data, dbt to process the data, and python to do AI.

Check warning on line 40 in docs/docs-beta/docs/guides/build/components.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Terms.engineering] Use 'Python' instead of 'python'. Raw Output: {"message": "[Terms.engineering] Use 'Python' instead of 'python'.", "location": {"path": "docs/docs-beta/docs/guides/build/components.md", "range": {"start": {"line": 40, "column": 109}}}, "severity": "WARNING"}

### Ingest

First we set up sling.

0 comments on commit 5f72d64

Please sign in to comment.