From a612b237caa191af8945f551aa675522438abb82 Mon Sep 17 00:00:00 2001 From: Pankaj Singh <98807258+pankajastro@users.noreply.github.com> Date: Tue, 31 Dec 2024 19:04:12 +0530 Subject: [PATCH] Docs: Fix broken links and rendering (#1437) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 1. Link docs/custom-airflow-properties.rst in index 2. Fix syntax warning of docs/getting_started/azure-container-instance.rst 3. Fix the example broken link at: https://astronomer.github.io/astronomer-cosmos/configuration/scheduling.html#examples 4. [Pypi](https://pypi.org/project/astronomer-cosmos/) is not loading image correctly Screenshot 2024-12-31 at 6 02 38 PM --- README.rst | 2 +- docs/configuration/scheduling.rst | 2 +- docs/getting_started/azure-container-instance.rst | 3 +++ docs/getting_started/index.rst | 1 + 4 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index e35b8a913..316870558 100644 --- a/README.rst +++ b/README.rst @@ -46,7 +46,7 @@ https://github.com/astronomer/astronomer-cosmos/blob/24aa38e528e299ef51ca6baf32f This will generate an Airflow DAG that looks like this: -.. figure:: /docs/_static/jaffle_shop_dag.png +.. figure:: https://github.com/astronomer/astronomer-cosmos/blob/main/docs/_static/jaffle_shop_dag.png Community diff --git a/docs/configuration/scheduling.rst b/docs/configuration/scheduling.rst index 9cc138e6f..67ed1a10c 100644 --- a/docs/configuration/scheduling.rst +++ b/docs/configuration/scheduling.rst @@ -73,7 +73,7 @@ This example DAG: .. The following renders in Sphinx but not Github: -.. literalinclude:: ./../dev/dags/basic_cosmos_dag.py +.. literalinclude:: ../../dev/dags/basic_cosmos_dag.py :language: python :start-after: [START local_example] :end-before: [END local_example] diff --git a/docs/getting_started/azure-container-instance.rst b/docs/getting_started/azure-container-instance.rst index 39ad9fb73..86ce3ab9e 100644 --- a/docs/getting_started/azure-container-instance.rst +++ b/docs/getting_started/azure-container-instance.rst @@ -3,6 +3,7 @@ Azure Container Instance Execution Mode ======================================= .. versionadded:: 1.4 + This tutorial will guide you through the steps required to use Azure Container Instance as the Execution Mode for your dbt code with Astronomer Cosmos. Schematically, the guide will walk you through the steps required to build the following architecture: .. figure:: https://github.com/astronomer/astronomer-cosmos/raw/main/docs/_static/cosmos_aci_schematic.png @@ -54,6 +55,7 @@ You will need a postgres database running to be used as the database for the dbt In order to run a container in Azure Container Instance, it needs access to the container image. In our setup, we will use Azure Container Registry for this. To set an Azure Container Registry up, you can use the following bash command: .. code-block:: bash + az acr create --name <<>> --resource-group <<>> --sku Basic --admin-enabled **Build the dbt Docker image** @@ -82,6 +84,7 @@ After this, the image needs to be pushed to the registry of your choice. Note th You may need to ensure docker knows to use the right credentials. If using Azure Container Registry, this can be done by running the following command: .. code-block:: bash + az acr login .. note:: diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst index 958f115e1..82372aa9a 100644 --- a/docs/getting_started/index.rst +++ b/docs/getting_started/index.rst @@ -15,6 +15,7 @@ GCP Cloud Run Job Execution Mode dbt and Airflow Similar Concepts Operators + Custom Airflow Properties Getting Started