-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doc 302 new etl tutorial #25320
base: master
Are you sure you want to change the base?
Doc 302 new etl tutorial #25320
Conversation
Deploy preview for dagster-docs-beta ready! Preview available at https://dagster-docs-beta-nygnby14m-elementl.vercel.app Direct link to changed pages: |
I've been looking at pyproject.toml, setup.cfg and setup.py and thinking that could be pyproject.toml only for many projects. Especially for beginner level tutorials. |
|
||
## Step 1: Create Dagster Project Files | ||
|
||
Dagster needs several project files to run. These files are common in Python Package managment and help manage project configurationa and dependencies. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a minor typo in the word "configurationa". It should be "configuration". This small correction will improve the readability of the documentation.
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
|
||
2. Create Setup Python File | ||
|
||
The setup.py file is a build script for configuring Python packages. In a Dagster project, you use setup.py to defin any Python packages your project depends on, including Dagster itself. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a minor typo in the word defin
. It should be define
. This small correction will improve the clarity of the explanation for the setup.py
file's purpose.
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
|
||
## Building definitions object | ||
|
||
The definitions object [need docs reference] in Dagster serves as the central configuration point for defining and organizing various componenets within a Dagster Project. It acts as a container that holds all the necessary configurations for a code location, ensuring that everything is organized and easily accessible. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a minor typo in the word "componenets". It should be spelled "components". Additionally, consider adding a link to the Dagster documentation for the Definitions
object to provide more context for readers.
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
Summary & Motivation
I'm a little way into this and would like to get feedback from @PedramNavid and @cmpadden on the structure and general flow. This isn't done at this point, but I figure we could collaborate here and iterate from there.
I made some changes to the reference file to make it more concise regarding metadata output. The new code example function works great.
Main Questions I have at this point:
How I Tested These Changes
Changelog