[GitHub] [airflow] mik-laj edited a comment on issue #8282: Missing crossreferences between hooks and guides

[GitBox]

mik-laj edited a comment on issue #8282:
URL: https://github.com/apache/airflow/issues/8282#issuecomment-650713349


   Currently, operators have a reference between the documentation and the 
class.
   <img width="856" alt="Screenshot 2020-06-28 at 09 43 36" 
src="https://user-images.githubusercontent.com/12058428/85941636-4ec95500-b924-11ea-8408-8b89aa499e0c.png";>
   https://airflow.readthedocs.io/en/latest/howto/operator/gcp/compute.html
   <img width="782" alt="Screenshot 2020-06-28 at 09 43 46" 
src="https://user-images.githubusercontent.com/12058428/85941642-512baf00-b924-11ea-9b12-ea64b0c77eee.png";>
   
https://airflow.readthedocs.io/en/latest/_api/airflow/providers/google/cloud/operators/compute/index.html#airflow.providers.google.cloud.operators.compute.ComputeEngineStartInstanceOperator
   
   Based on this, I came up with the idea that a reference between the hook and 
the connection type would be useful.
   
   In the case of Google, means that you must add a reference to the connection 
configuration in class A.
   Here is docstring for GoogleBaseHook
   
https://airflow.readthedocs.io/en/latest/_api/airflow/providers/google/common/hooks/base_google/index.html#airflow.providers.google.common.hooks.base_google.GoogleBaseHook
   Here are docs for Google connection:
   https://airflow.readthedocs.io/en/latest/howto/connection/gcp.html
   However, we have more classes that have no references. A list of all 
connections is available. Here is the complete list of connections that have 
documentation.
   
https://airflow.readthedocs.io/en/latest/howto/connection/index.html#connection-types
   
   If there are many hooks that use a given type of connection, only the base 
class should have a note i.e. GoogleBaseHook should have a reference, 
CloudFirestoreHook should not have a reference.
   
   


----------------------------------------------------------------
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