Component-ize docs and examples #29506
Conversation
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
neverett
changed the title
## Summary & Motivation Updating hello world example on the main page by removing the explicit `Definitions` object. This example would still load probably with `dagster dev -f hello-world.py` and would not need the assets set in the Definitions if scaffolded with `dg`. ## How I Tested These Changes ## Changelog > Insert changelog entry or delete this section.
## Summary & Motivation Update examples consistency by removing `setup.py` from already merged examples ## How I Tested These Changes ## Changelog > Insert changelog entry or delete this section.
## Summary & Motivation * Update navigation to use component language * Include `definitions.py` in trees #29506 (comment) ## How I Tested These Changes ## Changelog > Insert changelog entry or delete this section.
## Summary & Motivation * Remove dg plugin doc for now (created followup ticket to document registry modules) * Remove preview note from most Components docs (left on index page) * Use `<project-name>` in project docs for consistency * Update `tree` output in project file reference doc to include both `uv` and `pip` output ## How I Tested These Changes Local build ## Changelog > Insert changelog entry or delete this section. --------- Signed-off-by: nikki everett <nikki@dagsterlabs.com>
## Summary & Motivation ## How I Tested These Changes ## Changelog > Insert changelog entry or delete this section.
## Summary & Motivation * Rename components for better clarity * Small typos and cleanup ## How I Tested These Changes ## Changelog > Insert changelog entry or delete this section.
## Summary & Motivation Addresses feedback on Quickstart and incorporates those changes into the "Creating a project" doc as well. ## How I Tested These Changes ## Changelog > Insert changelog entry or delete this section. --------- Signed-off-by: nikki everett <nikki@dagsterlabs.com>
|
@dehume @neverett , below you can find my feedback for the ETL pipeline tutorial. /etl-pipeline-tutorial
/etl-pipeline-tutorial/extract-data
/etl-pipeline-tutorial/transform-data
/etl-pipeline-tutorial/join-customer-and-order-data
/etl-pipeline-tutorial/partition-asset
/etl-pipeline-tutorial/create-a-sensor
/etl-pipeline-tutorial/visualize-data
|
|
Incorporated most of Colton's feedback into the ETL tutorial except holding off on:
Elsewhere in the documentation it seemed like we were coalescing around just |
Sounds good - thank you Dennis. |
## Summary Enable rendering nested command info in the Sphinx docs for `dg` CLI. Enable for all commands except scaffold - this compiles correctly but produces invalid `.md` files for some reason, investigating.
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
## Summary & Motivation Colton feedback #29506 (comment) And remove Sling ## How I Tested These Changes ## Changelog > Insert changelog entry or delete this section. --------- Signed-off-by: nikki everett <nikki@dagsterlabs.com> Co-authored-by: Nikki Everett <neverett@users.noreply.github.com> Co-authored-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Summary & Motivation
Preview: https://dgify-docs-and-examples.archive.dagster-docs.io
This PR makes the following changes:
create-dagsterCLIdefs = dg.Definitions()lines and move resource definitions to separateresources.pyfilesdgCLI to scaffold Dagster definitions, where appropriatedgCLI API docs section added, which includescreate-dagsterCLI documentationHow I Tested These Changes
Local build
Changelog