From 6713ef2b83fc7f1f183f4b24b917897c3853df7a Mon Sep 17 00:00:00 2001 From: Pankaj Date: Thu, 18 Jul 2024 20:22:08 +0530 Subject: [PATCH 1/2] Use Airflow trademark as it has been registered --- README.rst | 2 +- docs/configuration/hosting-docs.rst | 2 +- docs/configuration/scheduling.rst | 2 +- docs/contributing.rst | 2 +- docs/getting_started/docker.rst | 2 +- docs/getting_started/execution-modes-local-conflicts.rst | 2 +- docs/index.rst | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 0310114d7..e9c24a3f5 100644 --- a/README.rst +++ b/README.rst @@ -20,7 +20,7 @@ |fury| |ossrank| |downloads| |pre-commit| -Run your dbt Core projects as `Apache Airflow `_ DAGs and Task Groups with a few lines of code. Benefits include: +Run your dbt Core projects as `Apache Airflow® `_ DAGs and Task Groups with a few lines of code. Benefits include: - Run dbt projects against Airflow connections instead of dbt profiles - Native support for installing and running dbt in a virtual environment to avoid dependency conflicts with Airflow diff --git a/docs/configuration/hosting-docs.rst b/docs/configuration/hosting-docs.rst index 755bfe815..e94db35ad 100644 --- a/docs/configuration/hosting-docs.rst +++ b/docs/configuration/hosting-docs.rst @@ -3,7 +3,7 @@ Hosting Docs ============ -dbt docs can be served directly from the Apache Airflow webserver with the Cosmos Airflow plugin, without requiring the user to set up anything outside of Airflow. This page describes how to host docs in the Airflow webserver directly, although some users may opt to host docs externally. +dbt docs can be served directly from the Apache Airflow® webserver with the Cosmos Airflow plugin, without requiring the user to set up anything outside of Airflow. This page describes how to host docs in the Airflow webserver directly, although some users may opt to host docs externally. Overview ~~~~~~~~ diff --git a/docs/configuration/scheduling.rst b/docs/configuration/scheduling.rst index d96930395..d9df434de 100644 --- a/docs/configuration/scheduling.rst +++ b/docs/configuration/scheduling.rst @@ -24,7 +24,7 @@ To schedule a dbt project on a time-based schedule, you can use Airflow's schedu Data-Aware Scheduling --------------------- -Apache Airflow 2.4 introduced the concept of `scheduling based on Datasets `_. +Apache Airflow® 2.4 introduced the concept of `scheduling based on Datasets `_. By default, if Airflow 2.4 or higher is used, Cosmos emits `Airflow Datasets `_ when running dbt projects. This allows you to use Airflow's data-aware scheduling capabilities to schedule your dbt projects. Cosmos emits datasets using the OpenLineage URI format, as detailed in the `OpenLineage Naming Convention `_. diff --git a/docs/contributing.rst b/docs/contributing.rst index 56826cfc8..8a23b718a 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -91,7 +91,7 @@ We currently use `hatch `_ for building and distr The tool can also be used for local development. The `pyproject.toml `_ file currently defines a matrix of supported versions of Python and Airflow for which a user can run the tests against. -For instance, to run the tests using Python 3.10 and Apache Airflow 2.5, use the following: +For instance, to run the tests using Python 3.10 and Apache Airflow® 2.5, use the following: .. code-block:: bash diff --git a/docs/getting_started/docker.rst b/docs/getting_started/docker.rst index 73db3be7a..f8760ef14 100644 --- a/docs/getting_started/docker.rst +++ b/docs/getting_started/docker.rst @@ -22,7 +22,7 @@ Step-by-step instructions **Install Airflow and Cosmos** -Create a python virtualenv, activate it, upgrade pip to the latest version and install apache airflow & astronomer-postgres +Create a python virtualenv, activate it, upgrade pip to the latest version and install apache airflow® & astronomer-postgres .. code-block:: bash diff --git a/docs/getting_started/execution-modes-local-conflicts.rst b/docs/getting_started/execution-modes-local-conflicts.rst index 3f537baba..d0a787e18 100644 --- a/docs/getting_started/execution-modes-local-conflicts.rst +++ b/docs/getting_started/execution-modes-local-conflicts.rst @@ -4,7 +4,7 @@ Airflow and dbt dependencies conflicts ====================================== When using the `Local Execution Mode `__, users may face dependency conflicts between -Apache Airflow and dbt. The conflicts may increase depending on the Airflow providers and dbt adapters being used. +Apache Airflow® and dbt. The conflicts may increase depending on the Airflow providers and dbt adapters being used. If you find errors, we recommend users look into using `alternative execution modes `__. diff --git a/docs/index.rst b/docs/index.rst index c22de1a7a..3bbd7fa9d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -28,7 +28,7 @@ |fury| |ossrank| |downloads| |pre-commit| -Run your dbt Core projects as `Apache Airflow `_ DAGs and Task Groups with a few lines of code. Benefits include: +Run your dbt Core projects as `Apache Airflow® `_ DAGs and Task Groups with a few lines of code. Benefits include: - Run dbt projects against Airflow connections instead of dbt profiles - Native support for installing and running dbt in a virtual environment to avoid dependency conflicts with Airflow From 769ab96b71c0c3d6ade2338b4e91be1d138c7cb7 Mon Sep 17 00:00:00 2001 From: Pankaj Date: Thu, 18 Jul 2024 23:31:41 +0530 Subject: [PATCH 2/2] Add Apache Airflow link --- docs/configuration/hosting-docs.rst | 2 +- docs/configuration/scheduling.rst | 2 +- docs/contributing.rst | 2 +- docs/getting_started/docker.rst | 2 +- docs/getting_started/execution-modes-local-conflicts.rst | 2 +- docs/getting_started/mwaa.rst | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/configuration/hosting-docs.rst b/docs/configuration/hosting-docs.rst index e94db35ad..7e531a438 100644 --- a/docs/configuration/hosting-docs.rst +++ b/docs/configuration/hosting-docs.rst @@ -3,7 +3,7 @@ Hosting Docs ============ -dbt docs can be served directly from the Apache Airflow® webserver with the Cosmos Airflow plugin, without requiring the user to set up anything outside of Airflow. This page describes how to host docs in the Airflow webserver directly, although some users may opt to host docs externally. +dbt docs can be served directly from the `Apache Airflow® `_ webserver with the Cosmos Airflow plugin, without requiring the user to set up anything outside of Airflow. This page describes how to host docs in the Airflow webserver directly, although some users may opt to host docs externally. Overview ~~~~~~~~ diff --git a/docs/configuration/scheduling.rst b/docs/configuration/scheduling.rst index d9df434de..16fccca14 100644 --- a/docs/configuration/scheduling.rst +++ b/docs/configuration/scheduling.rst @@ -24,7 +24,7 @@ To schedule a dbt project on a time-based schedule, you can use Airflow's schedu Data-Aware Scheduling --------------------- -Apache Airflow® 2.4 introduced the concept of `scheduling based on Datasets `_. +`Apache Airflow® `_ 2.4 introduced the concept of `scheduling based on Datasets `_. By default, if Airflow 2.4 or higher is used, Cosmos emits `Airflow Datasets `_ when running dbt projects. This allows you to use Airflow's data-aware scheduling capabilities to schedule your dbt projects. Cosmos emits datasets using the OpenLineage URI format, as detailed in the `OpenLineage Naming Convention `_. diff --git a/docs/contributing.rst b/docs/contributing.rst index 8a23b718a..53174ec3d 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -91,7 +91,7 @@ We currently use `hatch `_ for building and distr The tool can also be used for local development. The `pyproject.toml `_ file currently defines a matrix of supported versions of Python and Airflow for which a user can run the tests against. -For instance, to run the tests using Python 3.10 and Apache Airflow® 2.5, use the following: +For instance, to run the tests using Python 3.10 and `Apache Airflow® `_ 2.5, use the following: .. code-block:: bash diff --git a/docs/getting_started/docker.rst b/docs/getting_started/docker.rst index f8760ef14..ead5a3d32 100644 --- a/docs/getting_started/docker.rst +++ b/docs/getting_started/docker.rst @@ -22,7 +22,7 @@ Step-by-step instructions **Install Airflow and Cosmos** -Create a python virtualenv, activate it, upgrade pip to the latest version and install apache airflow® & astronomer-postgres +Create a python virtualenv, activate it, upgrade pip to the latest version and install `Apache Airflow® `_ & astronomer-postgres .. code-block:: bash diff --git a/docs/getting_started/execution-modes-local-conflicts.rst b/docs/getting_started/execution-modes-local-conflicts.rst index d0a787e18..21aa30ad7 100644 --- a/docs/getting_started/execution-modes-local-conflicts.rst +++ b/docs/getting_started/execution-modes-local-conflicts.rst @@ -4,7 +4,7 @@ Airflow and dbt dependencies conflicts ====================================== When using the `Local Execution Mode `__, users may face dependency conflicts between -Apache Airflow® and dbt. The conflicts may increase depending on the Airflow providers and dbt adapters being used. +`Apache Airflow® `_ and dbt. The conflicts may increase depending on the Airflow providers and dbt adapters being used. If you find errors, we recommend users look into using `alternative execution modes `__. diff --git a/docs/getting_started/mwaa.rst b/docs/getting_started/mwaa.rst index 0def60f49..8555cde34 100644 --- a/docs/getting_started/mwaa.rst +++ b/docs/getting_started/mwaa.rst @@ -3,7 +3,7 @@ Getting Started on MWAA ======================= -Users can face Python dependency issues when trying to use the Cosmos `Local Execution Mode `_ in Amazon Managed Workflows for Apache Airflow (MWAA). +Users can face Python dependency issues when trying to use the Cosmos `Local Execution Mode `_ in Amazon Managed Workflows for `Apache Airflow® `_ (MWAA). This step-by-step illustrates how to use the Local Execution Mode, together with the `MWAA's startup script `_ and