Missing crossreferences between hooks and guides

[mik-laj]

Hello,

We have a guide for many connection types and many hooks for these connections.

The following fragment should appear in the hook documentation:

    .. seealso::
        For more information on how to set-up connection for this hook, take a look at:
        :ref:`howto/connection:XXX`

If the class has subclasses, the note should only be in the base class.

Similar information should be found in the connection documentation.

    .. seealso::
        For more information on how to use the connection with the hook, take a look at:
        :class:`airflow`

The purpose of this change is to facilitate access to related parts of the documentation.

Best regards,
Kamil

[alexandrecaze]

Hi @mik-laj I am down to work on this issue.

[mik-laj]

@alexandraabbas Do you need any help?

[satishbellapu]

@mik-laj Is this still open for pick-up ?

[mik-laj]

@satishbellapu This task has not been completed. I assigned you to this ticket. I look forward to your contribution.

[satishbellapu]

@mik-laj can you be more clear on the requirement or some sample connector which has the ref as per your guideline should help me to close the PR at the earliest.

[mik-laj]

Currently, operators have a reference between the documentation and the class.

https://airflow.readthedocs.io/en/latest/howto/operator/gcp/compute.html

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.

[satishbellapu]

Thanks for the explanation @mik-laj will get back if i have questions.