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

Add links to example dags in use params section #41031

Merged
merged 5 commits into from
Jul 27, 2024

Conversation

harjeevanmaan
Copy link
Contributor

@harjeevanmaan harjeevanmaan commented Jul 25, 2024

closes: #40811

Added the Links and the paragraph about required fields in Params documentation.


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

Copy link

boring-cyborg bot commented Jul 25, 2024

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@harjeevanmaan harjeevanmaan deleted the params branch July 25, 2024 17:28
@harjeevanmaan harjeevanmaan restored the params branch July 25, 2024 17:36
@harjeevanmaan harjeevanmaan reopened this Jul 25, 2024
@shahar1 shahar1 changed the title Fixes #40811 Add links to example dags in use params section Jul 25, 2024
Copy link
Contributor

@shahar1 shahar1 left a comment

Choose a reason for hiding this comment

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

Welcome to Apache Airflow!
Good start, but please take a look at my comment below :)

docs/apache-airflow/core-concepts/params.rst Outdated Show resolved Hide resolved
@potiuk potiuk merged commit e7a2a9d into apache:main Jul 27, 2024
48 checks passed
Copy link

boring-cyborg bot commented Jul 27, 2024

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@utkarsharma2 utkarsharma2 added the type:doc-only Changelog: Doc Only label Jul 31, 2024
@utkarsharma2 utkarsharma2 added this to the Airflow 2.10.0 milestone Jul 31, 2024
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.

Add links to example dags in use params section
5 participants