Skip to content

Commit

Permalink
📝 docs(README.md): improve documentation to make its usage more sensi…
Browse files Browse the repository at this point in the history
…ble (#9)

* 📝 docs: Add command for running project

* 📝 docs: remove docker-compose up command

* 📝 docs: update readme for junior people

* 📝 docs: update usage

* 📝 docs: put command in back quote

* 📝 docs: update project usage

* 📝 docs: update project usage
  • Loading branch information
mehranasghari authored Sep 19, 2023
1 parent 99a933c commit 4ec528e
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ The end result is Airflow DAGs can be managed via Git best practices. Changes ar

## Project Usage 🧑‍💻


**Important Tip**:

Before you can use the project, based on [Airflow's documentation](https://airflow.apache.org/docs/apache-airflow/stable/howto/docker-compose/index.html#setting-the-right-airflow-user), you need to ensure that Airflow has the correct permissions for the required directories. To do this, execute the following commands in the directory where your `docker-compose.yaml` file is located:
Expand Down Expand Up @@ -108,9 +109,8 @@ echo -e "AIRFLOW_UID=$(id -u)" > .env
### Using Airflow Git Sync
Using Airflow Git Sync is simple:
1. Add the git-sync container to your docker-compose or Airflow deployment manifest.
2. Configure it via environment variables in `docker-compose.yaml` file:
1. Clone the repository.
2. Configure git-sync via environment variables in `docker-compose.yaml` file:
| Variable | Description | Default Value |
| --- | --- | --- |
Expand All @@ -119,9 +119,9 @@ Using Airflow Git Sync is simple:
| `DIRECTORY_NAME` | The name of the directory to clone the repository into | `project` |
| `DESTINATION_PATH` | The path to sync the repository to | `/app/sync` |
| `INTERVAL` | The interval (in seconds) to sync the repository | `10` |
3. Manage your DAG files in Git as usual. Changes will be automatically synced to Airflow containers.
4. Trigger automated deployments by pushing DAG changes to your Git repo.
3. In order to deploy the Airflow with the configured Git-sync, simply run the ‍`docker compose up -d‍` command.
4. Enjoy!
## Contributing 👥
Expand Down

0 comments on commit 4ec528e

Please sign in to comment.