You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2022/07/14 06:37:32 UTC
[GitHub] [airflow] VarunRauthan opened a new pull request, #25048: corrected the airflow variable hyper-link
VarunRauthan opened a new pull request, #25048:
URL: https://github.com/apache/airflow/pull/25048
<!--
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+Improvements+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] potiuk commented on a diff in pull request #25048: corrected the airflow variable hyper-link
Posted by GitBox <gi...@apache.org>.
potiuk commented on code in PR #25048:
URL: https://github.com/apache/airflow/pull/25048#discussion_r920837990
##########
docs/apache-airflow/howto/dynamic-dag-generation.rst:
##########
@@ -29,7 +29,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 </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 `Airflow Variables <https://airflow.apache.org/docs/apache-airflow/stable/best-practices.html#airflow-variables>`_
Review Comment:
I think something like that is beter (not 100% sure - you need to look it up as it is done in other places). The .rst files are processed by sphinx so if we are referring to other document in airflow docs we should use `:doc:` directive then when documentation is built, the right link will be generated. This is important because for example it will use the link to the right version of Airflow doc.
```suggestion
down parsing and place extra load on the DB. See the :doc:`Airflow Variables <_best_practices/airflow_variables>`
```
--
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] github-actions[bot] closed pull request #25048: corrected the airflow variable hyper-link
Posted by GitBox <gi...@apache.org>.
github-actions[bot] closed pull request #25048: corrected the airflow variable hyper-link
URL: https://github.com/apache/airflow/pull/25048
--
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] uranusjr commented on a diff in pull request #25048: corrected the airflow variable hyper-link
Posted by GitBox <gi...@apache.org>.
uranusjr commented on code in PR #25048:
URL: https://github.com/apache/airflow/pull/25048#discussion_r922894343
##########
docs/apache-airflow/howto/dynamic-dag-generation.rst:
##########
@@ -29,7 +29,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 </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 :doc:`Airflow Variables <_best_practices/airflow_variables>`
Review Comment:
```suggestion
down parsing and place extra load on the DB. See the :doc:`Airflow Variables <best_practices/airflow_variables>`
```
Leading underscore is a special restructuredText syntax (reference) and not a part of the actual object name.
--
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 #25048: corrected the airflow variable hyper-link
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on PR #25048:
URL: https://github.com/apache/airflow/pull/25048#issuecomment-1184054141
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 (flake8, 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] potiuk commented on pull request #25048: corrected the airflow variable hyper-link
Posted by GitBox <gi...@apache.org>.
potiuk commented on PR #25048:
URL: https://github.com/apache/airflow/pull/25048#issuecomment-1188055881
Nope. Docs are not building. please try to build it locally and fix teh problem
--
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] github-actions[bot] commented on pull request #25048: corrected the airflow variable hyper-link
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #25048:
URL: https://github.com/apache/airflow/pull/25048#issuecomment-1236444643
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.
--
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