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.

Sign up for GitHub

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

Jump to bottom

[docs-beta] Update Define data assets #24308

Merged
merged 1 commit into from
Sep 11, 2024
Merged

[docs-beta] Update Define data assets #24308

merged 1 commit into from
Sep 11, 2024

Conversation

PedramNavid
Copy link
Contributor

Summary & Motivation

Improving examples, clarifying language.

How I Tested These Changes

Changelog

NOCHANGELOG

@graphite-app graphite-app bot added the area: docs Related to documentation in general label Sep 8, 2024
@PedramNavid Graphite App
Copy link
Contributor Author

PedramNavid commented Sep 8, 2024 •
edited
Loading

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @PedramNavid and the rest of your teammates on Graphite Graphite

@PedramNavid PedramNavid force-pushed the pdrm09-08-_docs-beta_update_define_data_assets branch 2 times, most recently from ec67088 to 805f37e Compare September 8, 2024 07:13
@PedramNavid PedramNavid force-pushed the pdrm09-07-_docs-beta_add_create_a_pipeline_guide branch from a323cbd to 9df1769 Compare September 8, 2024 23:56
@PedramNavid PedramNavid force-pushed the pdrm09-08-_docs-beta_update_define_data_assets branch from 805f37e to 87d6278 Compare September 8, 2024 23:56
@graphite-app graphite-app bot added the docathon label Sep 9, 2024
@graphite-app Graphite App
Copy link

graphite-app bot commented Sep 9, 2024

Graphite Automations

"docs-beta - Assign Reviewers" took an action on this PR • (09/09/24)

1 label was added to this PR based on Pedram Navid's automation.

@PedramNavid PedramNavid force-pushed the pdrm09-07-_docs-beta_add_create_a_pipeline_guide branch 2 times, most recently from 70af628 to fc97b74 Compare September 9, 2024 04:07
@PedramNavid PedramNavid force-pushed the pdrm09-08-_docs-beta_update_define_data_assets branch from 87d6278 to e68d6ae Compare September 9, 2024 04:10
erinkcochran87
erinkcochran87 reviewed Sep 9, 2024
View reviewed changes
docs/docs-beta/docs/guides/data-assets.md

</details>

## Asset decorators
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's put this back so we can link to it. Without a heading, this part of the guide feels a little off. We can rename it if that's the problem, but there should be a heading here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The table below felt like part of the main # Define data assets heading. Not sure what other heading I would use. Asset decorators did not feel relevant but open to options

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm. I think what tripped me up here originally was it coming after the prereqs without a heading - it felt kinda shoehorned in.

What if we have the table come after the intro but before What you'll learn?:

The most common way to create a data asset in Dagster is by annotating a function with an asset decorator. The function computes the contents of the asset, such as a database table or file.

Dagster supports several ways of creating assets, but this guide will focus on using Python decorators to define data assets.

[table]

## What you'll learn

...

[Prereqs]

@PedramNavid PedramNavid force-pushed the pdrm09-07-_docs-beta_add_create_a_pipeline_guide branch 2 times, most recently from 1a7ae91 to 19cd374 Compare September 9, 2024 15:12
@PedramNavid PedramNavid force-pushed the pdrm09-08-_docs-beta_update_define_data_assets branch 2 times, most recently from 7abb26f to 52d2dd0 Compare September 9, 2024 15:12
@PedramNavid PedramNavid force-pushed the pdrm09-07-_docs-beta_add_create_a_pipeline_guide branch from 19cd374 to dad0f0b Compare September 9, 2024 21:01
@PedramNavid PedramNavid force-pushed the pdrm09-08-_docs-beta_update_define_data_assets branch from 52d2dd0 to 10f8b70 Compare September 9, 2024 21:01
@PedramNavid PedramNavid force-pushed the pdrm09-07-_docs-beta_add_create_a_pipeline_guide branch from dad0f0b to d76bc9b Compare September 9, 2024 21:06
@PedramNavid PedramNavid force-pushed the pdrm09-08-_docs-beta_update_define_data_assets branch from 10f8b70 to 691d053 Compare September 9, 2024 21:06
@PedramNavid PedramNavid force-pushed the pdrm09-07-_docs-beta_add_create_a_pipeline_guide branch from d76bc9b to 7f8201b Compare September 9, 2024 21:11
@PedramNavid PedramNavid force-pushed the pdrm09-08-_docs-beta_update_define_data_assets branch from 691d053 to 12b738e Compare September 9, 2024 21:12
@PedramNavid PedramNavid force-pushed the pdrm09-07-_docs-beta_add_create_a_pipeline_guide branch from 7f8201b to 81504cc Compare September 9, 2024 21:15
@PedramNavid PedramNavid force-pushed the pdrm09-08-_docs-beta_update_define_data_assets branch from 12b738e to ca0b820 Compare September 9, 2024 21:17
@PedramNavid PedramNavid force-pushed the pdrm09-07-_docs-beta_add_create_a_pipeline_guide branch from 81504cc to 5828c24 Compare September 9, 2024 22:47
@PedramNavid PedramNavid force-pushed the pdrm09-08-_docs-beta_update_define_data_assets branch 2 times, most recently from 2cad46d to 9b29034 Compare September 10, 2024 17:42
@PedramNavid PedramNavid mentioned this pull request Sep 10, 2024
Merged
3 tasks
@PedramNavid PedramNavid force-pushed the pdrm09-07-_docs-beta_add_create_a_pipeline_guide branch from 5828c24 to 153e55f Compare September 10, 2024 17:47
@PedramNavid PedramNavid force-pushed the pdrm09-08-_docs-beta_update_define_data_assets branch from 9b29034 to 2cb24f2 Compare September 10, 2024 17:47
@graphite-app graphite-app bot added the area: dagster-university Related to Dagster University label Sep 10, 2024
@github-actions GitHub Actions
Copy link

Deploy preview for dagit-core-storybook ready!

✅ Preview
https://dagit-core-storybook-d3guix9mb-elementl.vercel.app
https://pdrm09-08--docs-beta-update-define-data-assets.core-storybook.dagster-docs.io

Built with commit 65d453e.
This pull request is being automatically deployed with vercel-action

@github-actions GitHub Actions
Copy link

Deploy preview for dagit-storybook ready!

✅ Preview
https://dagit-storybook-j35d7jajk-elementl.vercel.app
https://pdrm09-08--docs-beta-update-define-data-assets.components-storybook.dagster-docs.io

Built with commit 65d453e.
This pull request is being automatically deployed with vercel-action

@github-actions GitHub Actions
Copy link

Deploy preview for dagster-university ready!

✅ Preview
https://dagster-university-jo9e91t97-elementl.vercel.app
https://pdrm09-08--docs-beta-update-define-data-assets.dagster-university.dagster-docs.io

Built with commit 65d453e.
This pull request is being automatically deployed with vercel-action

@github-actions GitHub Actions
Copy link

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-8qe4v9169-elementl.vercel.app
https://pdrm09-08--docs-beta-update-define-data-assets.dagster.dagster-docs.io

Direct link to changed pages:

@PedramNavid PedramNavid force-pushed the pdrm09-07-_docs-beta_add_create_a_pipeline_guide branch from 153e55f to a617d65 Compare September 11, 2024 15:46
@PedramNavid PedramNavid force-pushed the pdrm09-08-_docs-beta_update_define_data_assets branch from 65d453e to ef1459a Compare September 11, 2024 15:46
@erinkcochran87 erinkcochran87 removed area: dagster-university Related to Dagster University docathon labels Sep 11, 2024
@PedramNavid PedramNavid changed the base branch from pdrm09-07-_docs-beta_add_create_a_pipeline_guide to graphite-base/24308 September 11, 2024 16:23
@PedramNavid PedramNavid changed the base branch from graphite-base/24308 to master September 11, 2024 16:24
@PedramNavid PedramNavid force-pushed the pdrm09-08-_docs-beta_update_define_data_assets branch from ef1459a to c4031db Compare September 11, 2024 16:25
@PedramNavid PedramNavid merged commit a1456e5 into master Sep 11, 2024
1 of 3 checks passed
@PedramNavid Graphite App
Copy link
Contributor Author

Merge activity

@PedramNavid PedramNavid deleted the pdrm09-08-_docs-beta_update_define_data_assets branch September 11, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@erinkcochran87 erinkcochran87 erinkcochran87 approved these changes

@cmpadden cmpadden Awaiting requested review from cmpadden

Assignees
No one assigned
Labels
area: docs Related to documentation in general
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@PedramNavid @erinkcochran87