Skip to content

Commit

Permalink
Merge pull request #88 from astronomer/docs
Browse files Browse the repository at this point in the history
Doc-only fixes
  • Loading branch information
fritz-astronomer authored Feb 23, 2024
2 parents 8da9249 + c66df73 commit 9c4dcd9
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ Connections, Environment Variables, Pools, and DAG History between two Airflow i
---

**Artwork**
Orbiter logo [by Lorenzo](https://thenounproject.com/lorenzo.verdenelli/) used with permission
Starship logo [by Lorenzo](https://thenounproject.com/lorenzo.verdenelli/) used with permission
from [The Noun Project](https://thenounproject.com/icon/starship-6088295/)
under [Creative Commons](https://creativecommons.org/licenses/by/3.0/us/legalcode).
18 changes: 10 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,16 @@ pip install astronomer-starship
```

## Usage
1. Create a Workspace in Astro to hold your Deployments
2. [Create an Airflow Deployment](https://cloud.astronomer.io/) to match your existing Airflow
3. Run `astro dev init` with the [Astro CLI](https://docs.astronomer.io/astro/cli/overview) to create a new Airflow Deployment locally
4. Deploy your DAGs to the new Airflow Deployment with `astro deploy`
5. [Install Starship](#installation) (and any additional Python Dependencies) to your new Airflow Deployment
1. Create a [Workspace](https://docs.astronomer.io/astro/manage-workspaces) in [Astro](https://cloud.astronomer.io/) or [Software](https://docs.astronomer.io/software) to hold Astro Deployments
2. [Create an Astro Deployment](https://docs.astronomer.io/astro/create-deployment) matching the source Airflow deployment configuration as possible
3. Run `astro dev init` with the [Astro CLI](https://docs.astronomer.io/astro/cli/overview) to create a [Astro Project](https://docs.astronomer.io/astro/cli/develop-project) locally in your terminal
4. Add any DAGs to the `/dags` folder in the Astro Project
5. Complete any additional setup required to convert your existing Airflow deployment to an Astro Project
5. [Install Starship](#installation) (and any additional Python Dependencies) to the Astro Project
6. [Install Starship](#installation) to your existing Airflow Deployment
7. In the Airflow UI, navigate to the new `Astronomer` menu and select the `Migration Tool 🚀` option
8. Follow the prompts to migrate your metadata, or if needed, look at the instructions to use the Operator
4. [Deploy the Astro Project](https://docs.astronomer.io/astro/cli/astro-deploy) to the Astro Deployment with `astro deploy`
7. In the Airflow UI of the source Airflow deployment, navigate to the new `Astronomer` menu and select the `Migration Tool 🚀` option
8. Follow the UI prompts to migrate, or if needed, look at the instructions to use the Operator

## Compatability

Expand Down Expand Up @@ -73,6 +75,6 @@ This project is an Airflow Plugin that adds custom API routes. Ensure your envir
---
**Artwork**
Orbiter logo [by Lorenzo](https://thenounproject.com/lorenzo.verdenelli/) used with permission
Starship logo [by Lorenzo](https://thenounproject.com/lorenzo.verdenelli/) used with permission
from [The Noun Project](https://thenounproject.com/icon/starship-6088295/)
under [Creative Commons](https://creativecommons.org/licenses/by/3.0/us/legalcode).

0 comments on commit 9c4dcd9

Please sign in to comment.