From a44c55889092d76839a80ad8b988c24689e51b71 Mon Sep 17 00:00:00 2001 From: Kushal Malani Date: Wed, 29 May 2024 12:31:02 -0700 Subject: [PATCH] rename docs url across cli --- README.md | 4 ++-- airflow/include/exampledag.py | 2 +- airflow/include/readme | 6 +++--- airflow/include/requirements.txt | 2 +- airflow/include/settingsyml.yml | 2 +- cloud/auth/auth.go | 2 +- cmd/cloud/setup.go | 2 +- cmd/config.go | 2 +- houston/constants.go | 4 ++-- version/version.go | 4 ++-- 10 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 1e89de1b0..1d2c0cd95 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ The Astro CLI is a command-line interface for data orchestration. It allows you - `version` Show the running version of the Astro CLI - `workspace` Manage Astronomer Workspaces -For a list of available Astro CLI commands, see the [Astro CLI command reference](https://docs.astronomer.io/astro/cli/reference). +For a list of available Astro CLI commands, see the [Astro CLI command reference](https://www.astronomer.io/docs/astro/cli/reference). ## Install the Astro CLI @@ -208,7 +208,7 @@ Adding this entry to your `~/.astro/config.yaml` file turns on debugging for all ## Support -To resolve an issue, Astronomer recommends reviewing the [Astronomer documentation](https://docs.astronomer.io/astro/cli/overview) first. +To resolve an issue, Astronomer recommends reviewing the [Astronomer documentation](https://www.astronomer.io/docs/astro/cli/overview) first. If you're unable to resolve your issue after reviewing the documentation, you can post a question on the [Astronomer web forum](https://forum.astronomer.io) or you can contact [Astronomer support](https://support.astronomer.io). diff --git a/airflow/include/exampledag.py b/airflow/include/exampledag.py index 7a3b8b470..6e31cb033 100644 --- a/airflow/include/exampledag.py +++ b/airflow/include/exampledag.py @@ -15,7 +15,7 @@ accordingly each time it runs. For more explanation and getting started instructions, see our Write your -first DAG tutorial: https://docs.astronomer.io/learn/get-started-with-airflow +first DAG tutorial: https://www.astronomer.io/docs/learn/get-started-with-airflow ![Picture of the ISS](https://www.esa.int/var/esa/storage/images/esa_multimedia/images/2010/02/space_station_over_earth/10293696-3-eng-GB/Space_Station_over_Earth_card_full.jpg) """ diff --git a/airflow/include/readme b/airflow/include/readme index 699fda7b9..599d70343 100644 --- a/airflow/include/readme +++ b/airflow/include/readme @@ -9,7 +9,7 @@ Project Contents Your Astro project contains the following files and folders: - dags: This folder contains the Python files for your Airflow DAGs. By default, this directory includes one example DAG: - - `example_astronauts`: This DAG shows a simple ETL pipeline example that queries the list of astronauts currently in space from the Open Notify API and prints a statement for each astronaut. The DAG uses the TaskFlow API to define tasks in Python, and dynamic task mapping to dynamically print a statement for each astronaut. For more on how this DAG works, see our [Getting started tutorial](https://docs.astronomer.io/learn/get-started-with-airflow). + - `example_astronauts`: This DAG shows a simple ETL pipeline example that queries the list of astronauts currently in space from the Open Notify API and prints a statement for each astronaut. The DAG uses the TaskFlow API to define tasks in Python, and dynamic task mapping to dynamically print a statement for each astronaut. For more on how this DAG works, see our [Getting started tutorial](https://www.astronomer.io/docs/learn/get-started-with-airflow). - Dockerfile: This file contains a versioned Astro Runtime Docker image that provides a differentiated Airflow experience. If you want to execute other commands or overrides at runtime, specify them here. - include: This folder contains any additional files that you want to include as part of your project. It is empty by default. - packages.txt: Install OS-level packages needed for your project by adding them to this file. It is empty by default. @@ -31,7 +31,7 @@ This command will spin up 4 Docker containers on your machine, each for a differ 2. Verify that all 4 Docker containers were created by running 'docker ps'. -Note: Running 'astro dev start' will start your project with the Airflow Webserver exposed at port 8080 and Postgres exposed at port 5432. If you already have either of those ports allocated, you can either [stop your existing Docker containers or change the port](https://docs.astronomer.io/astro/test-and-troubleshoot-locally#ports-are-not-available). +Note: Running 'astro dev start' will start your project with the Airflow Webserver exposed at port 8080 and Postgres exposed at port 5432. If you already have either of those ports allocated, you can either [stop your existing Docker containers or change the port](https://www.astronomer.io/docs/astro/cli/troubleshoot-locally#ports-are-not-available-for-my-local-airflow-webserver). 3. Access the Airflow UI for your local Airflow project. To do so, go to http://localhost:8080/ and log in with 'admin' for both your Username and Password. @@ -40,7 +40,7 @@ You should also be able to access your Postgres Database at 'localhost:5432/post Deploy Your Project to Astronomer ================================= -If you have an Astronomer account, pushing code to a Deployment on Astronomer is simple. For deploying instructions, refer to Astronomer documentation: https://docs.astronomer.io/cloud/deploy-code/ +If you have an Astronomer account, pushing code to a Deployment on Astronomer is simple. For deploying instructions, refer to Astronomer documentation: https://www.astronomer.io/docs/astro/deploy-code/ Contact ======= diff --git a/airflow/include/requirements.txt b/airflow/include/requirements.txt index 4e0af7927..1bb359bb3 100644 --- a/airflow/include/requirements.txt +++ b/airflow/include/requirements.txt @@ -1 +1 @@ -# Astro Runtime includes the following pre-installed providers packages: https://docs.astronomer.io/astro/runtime-image-architecture#provider-packages +# Astro Runtime includes the following pre-installed providers packages: https://www.astronomer.io/docs/astro/runtime-image-architecture#provider-packages diff --git a/airflow/include/settingsyml.yml b/airflow/include/settingsyml.yml index fe542bcf9..1c16dc0c7 100644 --- a/airflow/include/settingsyml.yml +++ b/airflow/include/settingsyml.yml @@ -1,7 +1,7 @@ # This file allows you to configure Airflow Connections, Pools, and Variables in a single place for local development only. # NOTE: json dicts can be added to the conn_extra field as yaml key value pairs. See the example below. -# For more information, refer to our docs: https://docs.astronomer.io/develop-project#configure-airflow_settingsyaml-local-development-only +# For more information, refer to our docs: https://www.astronomer.io/docs/astro/cli/develop-project#configure-airflow_settingsyaml-local-development-only # For questions, reach out to: https://support.astronomer.io # For issues create an issue ticket here: https://github.com/astronomer/astro-cli/issues diff --git a/cloud/auth/auth.go b/cloud/auth/auth.go index 18d862dd8..1d0278a89 100644 --- a/cloud/auth/auth.go +++ b/cloud/auth/auth.go @@ -354,7 +354,7 @@ func Login(domain, token string, coreClient astrocore.CoreClient, platformCoreCl } // Welcome User fmt.Print("\nWelcome to the Astro CLI 🚀\n\n") - fmt.Print("To learn more about Astro, go to https://docs.astronomer.io\n\n") + fmt.Print("To learn more about Astro, go to https://astronomer.io/docs\n\n") c, _ := context.GetCurrentContext() diff --git a/cmd/cloud/setup.go b/cmd/cloud/setup.go index 5f26500f3..857c83adf 100644 --- a/cmd/cloud/setup.go +++ b/cmd/cloud/setup.go @@ -243,7 +243,7 @@ func checkAPIKeys(platformCoreClient astroplatformcore.CoreClient, isDeploymentF } if !isDeploymentFile { fmt.Println("Using an Astro API key") - fmt.Println("\nWarning: Starting June 1st, 2024, Deployment API Keys will stop working. To ensure uninterrupted access to our services, we strongly recommend transitioning to Deployment API tokens. See https://docs.astronomer.io/astro/deployment-api-tokens.") + fmt.Println("\nWarning: Starting June 1st, 2024, Deployment API Keys will stop working. To ensure uninterrupted access to our services, we strongly recommend transitioning to Deployment API tokens. See https://www.astronomer.io/docs/astro/deployment-api-tokens") } // get authConfig diff --git a/cmd/config.go b/cmd/config.go index 009e2bd99..48b8bcd1b 100644 --- a/cmd/config.go +++ b/cmd/config.go @@ -30,7 +30,7 @@ func newConfigRootCmd(out io.Writer) *cobra.Command { cmd := &cobra.Command{ Use: "config", Short: "Manage a project's configurations", - Long: "Manage the project configurations stored at '.astro/config.yaml'. Please see https://docs.astronomer.io/astro/cli/configure-cli#available-cli-configurations for list of available cli configurations", + Long: "Manage the project configurations stored at '.astro/config.yaml'. Please see https://www.astronomer.io/docs/astro/cli/configure-cli#available-cli-configurations for list of available cli configurations", PersistentPreRunE: ensureGlobalFlag, } cmd.PersistentFlags().BoolVarP(&globalFlag, "global", "g", false, "view or modify global config") diff --git a/houston/constants.go b/houston/constants.go index 32a6470a1..fbf7cdcbe 100644 --- a/houston/constants.go +++ b/houston/constants.go @@ -27,6 +27,6 @@ const ( ImageDeploymentType = "image" DagOnlyDeploymentType = "dag_deploy" - DagDeployDocsLink = "https://docs.astronomer.io/software/deploy-dags/" - DeployViaCLIDocsLink = "https://docs.astronomer.io/software/deploy-cli/" + DagDeployDocsLink = "https://www.astronomer.io/docs/software/deploy-dags/" + DeployViaCLIDocsLink = "https://www.astronomer.io/docs/software/deploy-cli/" ) diff --git a/version/version.go b/version/version.go index 827c34216..2569ecc75 100644 --- a/version/version.go +++ b/version/version.go @@ -77,9 +77,9 @@ func CompareVersions(client *github.Client, owner, repo string) error { if runtime.GOOS == "darwin" { fmt.Fprintf(os.Stderr, "\nA newer version of Astro CLI is available: %s\nPlease update to the latest version using 'brew upgrade astro'\n\n", latestSemver) } else { - fmt.Fprintf(os.Stderr, "\nA newer version of Astro CLI is available: %s\nPlease see https://docs.astronomer.io/astro/cli/install-cli#upgrade-the-cli for information on how to update the Astro CLI\n\n", latestSemver) + fmt.Fprintf(os.Stderr, "\nA newer version of Astro CLI is available: %s\nPlease see https://www.astronomer.io/docs/astro/cli/install-cli#upgrade-the-astro-cli for information on how to update the Astro CLI\n\n", latestSemver) } - fmt.Fprint(os.Stderr, ansi.Cyan("\nTo learn more about what's new in this version, please see https://docs.astronomer.io/astro/cli/release-notes\n\n")) + fmt.Fprint(os.Stderr, ansi.Cyan("\nTo learn more about what's new in this version, please see https://www.astronomer.io/docs/astro/cli/release-notes\n\n")) fmt.Fprintf(os.Stderr, "If you don't want to see this message again run 'astro config set -g upgrade_message false'or pass '2>/dev/null | head' to print this text to stderr\n\n") }