mik-laj opened a new issue #8894:
URL: https://github.com/apache/airflow/issues/8894


   Hello,
   
   We have a lot of guides that are fantastic. 
   https://airflow.readthedocs.io/en/latest/howto/operator/index.html
   https://airflow.readthedocs.io/en/latest/howto/operator/gcp/index.html
   However, not every person may be aware that they exist. In order to promote 
them, we add a reference in the class description to the guide. In order to 
promote them, we add a reference in the class description to the guide.
   ![Screenshot 2020-05-17 at 20 07 
41](https://user-images.githubusercontent.com/12058428/82156193-27d62880-987a-11ea-9332-92d2598f9d83.png)
   Finding operators that have a guide is simple and can be based on the 
expression pattern search.
   ```
   find . -type f -name '*.rst' | xargs cat  | grep '.. _howto/operator:' | sort
   ```
   In the next step we should find the operator and check the class description 
for reference to the guide
   ```
   >>> from airflow.operators import python
   >>> ':ref:`howto/operator:PythonOperator`' in python.PythonOperator.__doc__
   ```
   This test should be added to this:
   * if you can do it without loading the python modules (text only operation), 
because the documentation process assumes that you don't have to have all 
libraries installed, then in this file:
   https://github.com/apache/airflow/blob/master/docs/build 
   * If you have to load Python modules, , then in this file:
   
https://github.com/apache/airflow/blob/master/tests/test_project_structure.py 
   


----------------------------------------------------------------
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:
us...@infra.apache.org


Reply via email to