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 2020/12/29 23:25:58 UTC
[GitHub] [airflow] soltanianalytics opened a new pull request #13375: Improves documentation regarding providers and custom connections
soltanianalytics opened a new pull request #13375:
URL: https://github.com/apache/airflow/pull/13375
I had some issues figuring out how to make custom connections work. Thankfully, @potiuk was very supporting in the airflow slack channel and helped me out. I'm happy to contribute to the docs in a way that I believe I would have found very helpful initially.
In particular:
- The `How to create your own provider` section should be on the main level, otherwise it is easy to overlook and also is confusing with the very similarly named `Creating your own providers` susection of the `FAQ for Airflow and Providers` - especially since you may be linked to this page from the connection page, looking for information on, well, _creating your own providers_
- I added a verbose section on what exactly to do to make a package a provider
- I took the liberty to also make some minor language improvements wherever I stumbled across an opportunity to do so
Please feel free to use it as-is, make any additional changes, or ignore my suggestions altogether.
Big thanks again to @potiuk for helping me out! The custom connections feature in particular is pretty cool!
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #13375: Improves documentation regarding providers and custom connections
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #13375:
URL: https://github.com/apache/airflow/pull/13375#issuecomment-752698050
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #13375: Improves documentation regarding providers and custom connections
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #13375:
URL: https://github.com/apache/airflow/pull/13375#issuecomment-752698006
The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest master or amend the last commit of the PR, and push it with --force-with-lease.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on a change in pull request #13375: Improves documentation regarding providers and custom connections
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #13375:
URL: https://github.com/apache/airflow/pull/13375#discussion_r550269038
##########
File path: docs/apache-airflow-providers/index.rst
##########
@@ -178,17 +177,51 @@ Creating your own providers
**When I write my own provider, do I need to do anything special to make it available to others?**
You do not need to do anything special besides creating the ``apache_airflow_provider`` entry point
-returning properly formatted meta-data (dictionary with ``extra-links`` and ``hook-class-names`` fields.
+returning properly formatted meta-data (dictionary with ``extra-links`` and ``hook-class-names`` fields).
+
+**What do I need to do to turn a package into a provider?**
Review comment:
:heart:
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #13375: Improves documentation regarding providers and custom connections
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #13375:
URL: https://github.com/apache/airflow/pull/13375#issuecomment-752274459
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/master/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (flake8, pylint and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/master/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/master/docs/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/master/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/master/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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk merged pull request #13375: Improves documentation regarding providers and custom connections
Posted by GitBox <gi...@apache.org>.
potiuk merged pull request #13375:
URL: https://github.com/apache/airflow/pull/13375
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org