This is an automated email from the ASF dual-hosted git repository.
amoghdesai pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new ea26595ed97 Updating operator extra links doc for AF3 (#50197)
ea26595ed97 is described below
commit ea26595ed97742355b8984a64ed00374b8b80d4c
Author: Amogh Desai <[email protected]>
AuthorDate: Wed May 7 12:04:33 2025 +0530
Updating operator extra links doc for AF3 (#50197)
---
airflow-core/docs/howto/define-extra-link.rst | 13 +++++++------
airflow-core/docs/img/operator_extra_link.png | Bin 75061 -> 90399 bytes
2 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/airflow-core/docs/howto/define-extra-link.rst
b/airflow-core/docs/howto/define-extra-link.rst
index 0a1f1b04689..83718773a9d 100644
--- a/airflow-core/docs/howto/define-extra-link.rst
+++ b/airflow-core/docs/howto/define-extra-link.rst
@@ -21,7 +21,7 @@
Define an operator extra link
=============================
-If you want to add further links to operators you can define them via a plugin
or provider package.
+If you want to add extra links to operators you can define them via a plugin
or provider package.
Extra links will be displayed in task details page in Grid view.
.. image:: ../img/operator_extra_link.png
@@ -60,7 +60,8 @@ The following code shows how to add extra links to an
operator via Plugins:
GoogleLink(),
]
-.. note:: Operator Extra Links should be registered via Airflow Plugins or
custom Airflow Provider to work.
+The extra links defined via custom Airflow Provider or Airflow operators will
be pushed as an xcom to the XCom table in
+metadata DB during task execution. During display in the grid view, this xcom
is retrieved and displayed.
You can also add a global operator extra link that will be available to
all the operators through an Airflow plugin or through Airflow providers. You
can learn more about it in the
@@ -93,7 +94,7 @@ tasks using
:class:`~airflow.providers.amazon.aws.transfers.gcs_to_s3.GCSToS3Ope
class S3LogLink(BaseOperatorLink):
name = "S3"
- # Add list of all the operators to which you want to add this
OperatorLinks
+ # Add list of all the operators to which you want to add this extra link
# Example: operators = [GCSToS3Operator, GCSToBigQueryOperator]
operators = [GCSToS3Operator]
@@ -120,9 +121,9 @@ tasks using
:class:`~airflow.providers.amazon.aws.transfers.gcs_to_s3.GCSToS3Ope
**Overriding Operator Links of Existing Operators**:
-It is also possible to replace a built in link on an operator via a Plugin.
For example
+It is also possible to replace a built-in link on an operator via a Plugin.
For example
:class:`~airflow.providers.google.cloud.operators.bigquery.BigQueryExecuteQueryOperator`
includes a link to the Google Cloud
-Console, but if we wanted to change that link we could:
+Console, but if we wanted to change that link we could do:
.. code-block:: python
@@ -173,7 +174,7 @@ specify the list of operators that provide extra link
capability. This happens b
class name in the ``provider-info`` information stored in your Provider's
package meta-data:
Example meta-data required in your provider-info dictionary (this is part of
the meta-data returned
-by ``apache-airflow-providers-google`` provider currently:
+by ``apache-airflow-providers-google`` provider currently):
.. code-block:: yaml
diff --git a/airflow-core/docs/img/operator_extra_link.png
b/airflow-core/docs/img/operator_extra_link.png
index e28dfb241bc..30302de841d 100644
Binary files a/airflow-core/docs/img/operator_extra_link.png and
b/airflow-core/docs/img/operator_extra_link.png differ
