Skip to content

Commit

Permalink
Adds registration icon and links to Airflow references (#190)
Browse files Browse the repository at this point in the history
"Airflow" has now been registered as a trademark in the US for the Apache Software Foundation. Whenever Airflow as a product is mentioned (especially in a commercial context), it must be referred "Apache Airflow®" and linked to https://airflow.apache.org. 

Given that the repo is owned by Astronomer, we will need to abide by the new rules. This commit updates all Airflow as a product references within the readme.
  • Loading branch information
cmarteepants authored Jul 17, 2024
1 parent 109d1c6 commit 7a82d86
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![Downloads](https://pepy.tech/badge/dag-factory)](https://pepy.tech/project/dag-factory)

Welcome to *dag-factory*! *dag-factory* is a library for [Apache Airflow](https://github.com/apache/incubator-airflow) to construct DAGs declaratively via configuration files.
Welcome to *dag-factory*! *dag-factory* is a library for [Apache Airflow®](https://airflow.apache.org) to construct DAGs declaratively via configuration files.

The minimum requirements for **dag-factory** are:
- Python 3.8.0+
- Apache Airflow 2.0+
- [Apache Airflow®](https://airflow.apache.org) 2.0+

For a gentle introduction, please take a look at our [Quickstart Guide](#quickstart). For more examples, please see the [examples](/examples) folder.

Expand All @@ -32,12 +32,12 @@ These tasks will be leveraging the `BashOperator` to execute simple bash command

![screenshot](/img/quickstart_dag.png)

1. To install *dag-factory*, run the following pip command in your Airflow environment:
1. To install *dag-factory*, run the following pip command in your [Apache Airflow®](https://airflow.apache.org) environment:
```bash
pip install dag-factory
```

2. Create a YAML configuration file called `config_file.yml` and save it within your airflow dags folder:
2. Create a YAML configuration file called `config_file.yml` and save it within your dags folder:
```yaml
example_dag1:
default_args:
Expand Down Expand Up @@ -77,7 +77,7 @@ dag_factory.clean_dags(globals())
dag_factory.generate_dags(globals())
```

After a few moments, the DAG will be generated and ready to run in Airflow. Unpause the DAG in the Airflow UI and watch the tasks execute!
After a few moments, the DAG will be generated and ready to run in Airflow. Unpause the DAG in the [Apache Airflow®](https://airflow.apache.org) UI and watch the tasks execute!

![screenshot](/img/quickstart_gantt.png)

Expand Down

0 comments on commit 7a82d86

Please sign in to comment.