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

Airflow tutorial #2985

Merged
merged 19 commits into from
Dec 13, 2024
Merged

Airflow tutorial #2985

merged 19 commits into from
Dec 13, 2024

Conversation

merobi-hub
Copy link
Collaborator

@merobi-hub merobi-hub commented Dec 6, 2024

Problem

We don't have much in the way of tutorials or guides in the docs, and Airflow is a common use case. We currently direct users back to the repo, which means that we're undoubtedly losing potential audience.

Solution

This adds an easy and quick tutorial on getting started locally with Marquez and Airflow.

To do:

  • add more detailed descriptions of information available from Airflow in Marquez
  • add resources to the next steps list
  • add a dag or two with datasets to give users a better example
  • add Postgres doc url
  • cut some of the screenshots (or most/all?) or add descriptions
  • add Windows equivalents for all commands?
  • remove unused images

Note: All database schema changes require discussion. Please link the issue for context.

One-line summary: adds an Airflow tutorial to the docs

Checklist

  • You've signed-off your work
  • Your changes are accompanied by tests (if relevant)
  • Your change contains a small diff and is self-contained
  • You've updated any relevant documentation (if relevant)
  • You've included a one-line summary of your change for the CHANGELOG.md (Depending on the change, this may not be necessary).
  • You've versioned your .sql database schema migration according to Flyway's naming convention (if relevant)
  • You've included a header in any source code files (if relevant)

Signed-off-by: merobi-hub <merobi@gmail.com>
@boring-cyborg boring-cyborg bot added the docs label Dec 6, 2024
@merobi-hub merobi-hub marked this pull request as draft December 6, 2024 15:02
Copy link

netlify bot commented Dec 6, 2024

Deploy Preview for peppy-sprite-186812 canceled.

Name Link
🔨 Latest commit 82b86a0
🔍 Latest deploy log https://app.netlify.com/sites/peppy-sprite-186812/deploys/675caf27f2f22a0008c8a408

Copy link

codecov bot commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.19%. Comparing base (7fb3d5e) to head (cda501e).

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #2985   +/-   ##
=========================================
  Coverage     81.19%   81.19%           
  Complexity     1506     1506           
=========================================
  Files           268      268           
  Lines          7360     7360           
  Branches        325      325           
=========================================
  Hits           5976     5976           
  Misses         1226     1226           
  Partials        158      158           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: merobi-hub <merobi@gmail.com>
@merobi-hub
Copy link
Collaborator Author

merobi-hub commented Dec 7, 2024

screencapture-localhost-3001-docs-tutorials-airflow-tutorial-2024-12-12-14_33_52

Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
@merobi-hub merobi-hub marked this pull request as ready for review December 8, 2024 22:38
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
Copy link
Member

@wslulciuc wslulciuc left a comment

Choose a reason for hiding this comment

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

Simply amazing! Thanks @merobi-hub for such a well thought out and written tutoria for Airflowl ❤️

@wslulciuc wslulciuc merged commit aa1cecf into main Dec 13, 2024
2 of 5 checks passed
@wslulciuc wslulciuc deleted the website/add-tutorial branch December 13, 2024 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants