From 5f72d643d212c54780a0251759ba9957efac26eb Mon Sep 17 00:00:00 2001 From: Sean Mackesey Date: Fri, 20 Dec 2024 15:48:50 -0500 Subject: [PATCH] [components] [docs] Initial components guide --- .../docs-beta/docs/guides/build/components.md | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/docs-beta/docs/guides/build/components.md diff --git a/docs/docs-beta/docs/guides/build/components.md b/docs/docs-beta/docs/guides/build/components.md new file mode 100644 index 0000000000000..59beba2a204b5 --- /dev/null +++ b/docs/docs-beta/docs/guides/build/components.md @@ -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 +- 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. + +## 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. + +### Ingest + +First we set up sling.