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 2018/08/04 17:47:29 UTC

[GitHub] XD-DENG commented on a change in pull request #3664: [AIRFLOW-2821] Refine Doc "Plugins"

XD-DENG commented on a change in pull request #3664: [AIRFLOW-2821] Refine Doc "Plugins"
URL: https://github.com/apache/incubator-airflow/pull/3664#discussion_r207714857
 
 

 ##########
 File path: docs/plugins.rst
 ##########
 @@ -78,6 +78,21 @@ looks like:
         menu_links = []
 
 
+You can derive it by inheritance (please refer to the example below). Please note ``name`` inside this class must be specified.
+
+After the plugin is imported into Airflow, you can invoke it using statement like
+
+.. code:: python
+
+    from airflow.{type, like "operators", "sensors", etc.}.{name specificed inside the plugin class} import *
+
+When you write your own plugins, make sure you understand them well. There are some essential properties for each type of plugin.
+For example,
 
 Review comment:
   Hi @ashb , I have updated accordingly. You can check the final looking via https://github.com/XD-DENG/incubator-airflow/blob/patch-3/docs/plugins.rst#interface
   
   Thanks.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on 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


With regards,
Apache Git Services