You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "Adaverse (via GitHub)" <gi...@apache.org> on 2023/02/02 17:17:59 UTC
[GitHub] [airflow] Adaverse opened a new pull request, #29338: Fixed link to airflow variable in docs
Adaverse opened a new pull request, #29338:
URL: https://github.com/apache/airflow/pull/29338
Background:
While going through the Dynamic DAG Generation doc -> https://airflow.apache.org/docs/apache-airflow/stable/howto/dynamic-dag-generation.html, found out one of the links to best practices while using airflow variable didn't work with error 404 not found. Have made changes and fixed the reference that points to the correct link now which is -> https://airflow.apache.org/docs/apache-airflow/stable/best-practices.html#airflow-variables.
Changes done:
replaced ```Airflow Variables <_best_practices/airflow_variables>`_``` with ```:ref:`best_practices/airflow_variables```
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
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](https://github.com/apache/airflow/tree/main/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #29338: Fixed link to airflow variable in docs
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #29338:
URL: https://github.com/apache/airflow/pull/29338#issuecomment-1416381810
Awesome work, congrats on your first merged pull request!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jedcunningham commented on a diff in pull request #29338: Fixed link to airflow variable in docs
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham commented on code in PR #29338:
URL: https://github.com/apache/airflow/pull/29338#discussion_r1095220401
##########
docs/apache-airflow/howto/dynamic-dag-generation.rst:
##########
@@ -40,7 +40,7 @@ If you want to use variables to configure your code, you should always use
`environment variables <https://wiki.archlinux.org/title/environment_variables>`_ in your
top-level code rather than :doc:`Airflow Variables </core-concepts/variables>`. Using Airflow Variables
at top-level code creates a connection to metadata DB of Airflow to fetch the value, which can slow
Review Comment:
```suggestion
in top-level code creates a connection to the metadata DB of Airflow to fetch the value, which can slow
```
##########
docs/apache-airflow/howto/dynamic-dag-generation.rst:
##########
@@ -40,7 +40,7 @@ If you want to use variables to configure your code, you should always use
`environment variables <https://wiki.archlinux.org/title/environment_variables>`_ in your
top-level code rather than :doc:`Airflow Variables </core-concepts/variables>`. Using Airflow Variables
at top-level code creates a connection to metadata DB of Airflow to fetch the value, which can slow
-down parsing and place extra load on the DB. See the `Airflow Variables <_best_practices/airflow_variables>`_
+down parsing and place extra load on the DB. See the :ref:`best_practices/airflow_variables`
on how to make best use of Airflow Variables in your DAGs using Jinja templates .
Review Comment:
```suggestion
down parsing and place extra load on the DB. See the `best practices on Airflow Variables <best_practices/airflow_variables>`_
to make the best use of Airflow Variables in your DAGs using Jinja templates.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] Adaverse commented on pull request #29338: Fixed link to airflow variable in docs
Posted by "Adaverse (via GitHub)" <gi...@apache.org>.
Adaverse commented on PR #29338:
URL: https://github.com/apache/airflow/pull/29338#issuecomment-1416052790
@jedcunningham can it be merged now?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jedcunningham merged pull request #29338: Fixed link to airflow variable in docs
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham merged PR #29338:
URL: https://github.com/apache/airflow/pull/29338
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #29338: Fixed link to airflow variable in docs
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #29338:
URL: https://github.com/apache/airflow/pull/29338#issuecomment-1414094278
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 Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (ruff, mypy and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) 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](https://github.com/apache/airflow/blob/main/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/BREEZE.rst) 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](https://www.apache.org/foundation/policies/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]( https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#coding-style-and-best-practices).
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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] Adaverse commented on pull request #29338: Fixed link to airflow variable in docs
Posted by "Adaverse (via GitHub)" <gi...@apache.org>.
Adaverse commented on PR #29338:
URL: https://github.com/apache/airflow/pull/29338#issuecomment-1414765628
> Thanks for the PR @Adaverse! While we are at it, we might as well fix up the grammar.
Thanks for the suggestions @jedcunningham. It's done.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jedcunningham commented on pull request #29338: Fixed link to airflow variable in docs
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham commented on PR #29338:
URL: https://github.com/apache/airflow/pull/29338#issuecomment-1416382194
Thanks @Adaverse! Congrats on your first commit 🎉
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org