Skip to content

Conversation

@cmarteepants
Copy link
Collaborator

@cmarteepants cmarteepants commented Apr 10, 2025

Summary

This PR improves the Airflow "Fundamental Concepts" tutorial by rewriting for better clarity, structure, and tone. It also updates screenshots for Airflow 3.

Related:

What's Included

  • Rewrites the Fundamental Concepts tutorial to be more conversational and beginner-friendly, while maintaining all technical accuracy and code examples
  • Updates screenshots to reflect the UI (😈 )
  • Adds screenshots for light mode too in case we move to a docs theme that supports light and dark mode
  • Groups screenshots by light and dark theme for organizational purposes

Why This Matters

The existing tutorial content was technically accurate but written in a style that could be intimidating or confusing for newcomers. This update provides a more natural learning path for users familiar with Python but new to Airflow, helping them build confidence as they go. Also: We need to update screenshots for Airflow 3 😄 and since I was there, I couldn't help but adjust it.

cmarteepants and others added 3 commits April 10, 2025 18:58
- Replaced screenshots for Airflow 3, dark mode
- Added light mode screenshots for future use
- Grouped dark and light screenshots together

add light screenshots, and group light and dark
…hability

This update rewords and restructures the Airflow “Fundamental Concepts” tutorial
to improve tone, clarity, and flow. The new version is more conversational and
guides users step-by-step through key Airflow concepts while keeping all code
examples intact. It’s designed to be more accessible for users who are new to
Airflow but have some technical background.

No changes were made to licensing or code snippets.
Copy link
Member

@jason810496 jason810496 left a comment

Choose a reason for hiding this comment

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

Thanks for the change! Looks great!
However, the static check isn’t happy — we need to use double backticks for code blocks to fix it.

Check if RST files use double backticks for code............................Failed
- hook id: rst-backticks
- exit code: 1

airflow-core/docs/tutorial/fundamentals.rst:83:`dag_id`, and specify the default arguments we just defined. We'll also set a schedule for our DAG to run every day.
airflow-core/docs/tutorial/fundamentals.rst:146:`{{ ds }}`. You can also pass files to the ``bash_command``, such as ``bash_command='templated_command.sh'``, allowing
airflow-core/docs/tutorial/fundamentals.rst:176:In Airflow, tasks can depend on one another. For instance, if you have tasks `t1`, `t2`, and `t3`, you can defined their
airflow-core/docs/tutorial/fundamentals.rst:232:`tutorial.py` within the dags folder specified in your ``airflow.cfg``, you can run:

@cmarteepants
Copy link
Collaborator Author

Thanks @jason810496! On me. I ran pre-commit manually before submitting the PR, but didn't verify with breeze. Pushed it through, hopefully the static tests pass.

@cmarteepants cmarteepants marked this pull request as draft April 11, 2025 13:44
@cmarteepants cmarteepants marked this pull request as ready for review April 11, 2025 14:24
@kaxil kaxil merged commit 1479f54 into apache:main Apr 11, 2025
48 checks passed
@cmarteepants cmarteepants deleted the docs-update-fundamentals branch April 11, 2025 23:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants