Skip to content

Commit fc61abb

Browse files
authored
Merge branch 'main' into add-docs-for-custom-ui-alerts
2 parents e0ac84d + ea26595 commit fc61abb

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

airflow-core/docs/howto/define-extra-link.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
Define an operator extra link
2222
=============================
2323

24-
If you want to add further links to operators you can define them via a plugin or provider package.
24+
If you want to add extra links to operators you can define them via a plugin or provider package.
2525
Extra links will be displayed in task details page in Grid view.
2626

2727
.. image:: ../img/operator_extra_link.png
@@ -60,7 +60,8 @@ The following code shows how to add extra links to an operator via Plugins:
6060
GoogleLink(),
6161
]
6262
63-
.. note:: Operator Extra Links should be registered via Airflow Plugins or custom Airflow Provider to work.
63+
The extra links defined via custom Airflow Provider or Airflow operators will be pushed as an xcom to the XCom table in
64+
metadata DB during task execution. During display in the grid view, this xcom is retrieved and displayed.
6465

6566
You can also add a global operator extra link that will be available to
6667
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
9394
class S3LogLink(BaseOperatorLink):
9495
name = "S3"
9596
96-
# Add list of all the operators to which you want to add this OperatorLinks
97+
# Add list of all the operators to which you want to add this extra link
9798
# Example: operators = [GCSToS3Operator, GCSToBigQueryOperator]
9899
operators = [GCSToS3Operator]
99100
@@ -120,9 +121,9 @@ tasks using :class:`~airflow.providers.amazon.aws.transfers.gcs_to_s3.GCSToS3Ope
120121
121122
**Overriding Operator Links of Existing Operators**:
122123

123-
It is also possible to replace a built in link on an operator via a Plugin. For example
124+
It is also possible to replace a built-in link on an operator via a Plugin. For example
124125
:class:`~airflow.providers.google.cloud.operators.bigquery.BigQueryExecuteQueryOperator` includes a link to the Google Cloud
125-
Console, but if we wanted to change that link we could:
126+
Console, but if we wanted to change that link we could do:
126127

127128
.. code-block:: python
128129
@@ -173,7 +174,7 @@ specify the list of operators that provide extra link capability. This happens b
173174
class name in the ``provider-info`` information stored in your Provider's package meta-data:
174175

175176
Example meta-data required in your provider-info dictionary (this is part of the meta-data returned
176-
by ``apache-airflow-providers-google`` provider currently:
177+
by ``apache-airflow-providers-google`` provider currently):
177178

178179
.. code-block:: yaml
179180
15 KB
Loading

0 commit comments

Comments
 (0)