docs icon indicating copy to clipboard operation
docs copied to clipboard

Make Install Astro CLI friendlier to new users

Open paolaperaza opened this issue 2 years ago • 1 comments

Issue Type

Missing or misleading content

Links to Affected Docs

Two Docs

  • https://docs.astronomer.io/astro/cli/install-cli
  • https://docs.astronomer.io/astro/cli/get-started-cli

Describe the Issue and Proposed Fix

Problem The Astro CLI install doc is the MAIN thing we push ALL users to in the Cloud UI as soon as they start a trial. For it to be this early in the process and in front of so many eyeballs, we should really optimize for clarity, conciseness, and explanations.

Proposed Fix

Install CLI

  • Add value-centric language to the Install Astro CLI doc that explains what the Astro CLI is and why you would use it.
  • Link to the Astro CLI overview to learn more.
  • Explore a more subtle Podman mention and make optional Docker thing more clear

For Get Started CLI

  • It's confusing as a user to decide "Do I install the CLI? Or do I get started with the CLI?" I would rename to `Run Airflow Locally

paolaperaza avatar Jun 05 '23 22:06 paolaperaza