Skip to content
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

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
Draft

Conversation

C00ldudeNoonan
Copy link
Contributor

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:

  1. Where will we put pictures for the new docs site? I want to add some UI screenshots for more color.
  2. How many explanations should I add here? I know on the previous site, the main complaint was that there was too much going on. I think having a couple of sentences explaining a concept is fine, with a link to the main page for that concept/API
  3. Should we hide the code examples and have the user reveal them or leave them as is?

How I Tested These Changes

Changelog

Insert changelog entry or delete this section.

@graphite-app graphite-app bot added the area: docs Related to documentation in general label Oct 16, 2024
@dbrtly
Copy link
Contributor

dbrtly commented Oct 17, 2024

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.

#25303

@PedramNavid PedramNavid marked this pull request as draft October 18, 2024 03:05

## 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.
Copy link

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.
Copy link

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.
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Related to documentation in general
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants