codewithsruthi opened a new pull request, #72754:
URL: https://github.com/apache/airflow/pull/72754

   ## Summary
   
   The published Quick Start is the second item in the Airflow docs toctree and 
the “getting started” link from the repo README. 
[#62298](https://github.com/apache/airflow/issues/62298) reported that it no 
longer behaves like a first-run page: the install command was prose instead of 
a copyable block, `[EXTRAS]` / `AIRFLOW_VERSION` / `PYTHON_VERSION` were 
unexplained placeholders, version examples were stale (`3.0.0`, `3.1.0`, 
`3.1.1`), `uv` was described as “add `uv` to the beginning of the command,” and 
the first screen also covered Poetry, pip-tools, constraints philosophy, a long 
Debian `apt` script, backfill, `airflow.cfg` / PID paths, and a six-process 
manual start that included `airflow users create` (FAB-only; Airflow 3 defaults 
to SimpleAuthManager).
   
   This PR slims Quick Start to the path a first-time user actually needs, and 
moves leftover run-separately instructions onto the existing installation pages 
instead of creating a second install guide.
   
   ### What changed
   
   **[airflow-core/docs/start.rst](airflow-core/docs/start.rst)** is now a 
short local-run walkthrough:
   
   1. **Before you start** — supported Python via a link to prerequisites (no 
version matrix paste), WSL2 on Windows, one sentence on Debian/Ubuntu PEP 668.
   2. **Fastest path** — `sphinx-design` tabs with full copyable commands: `uvx 
apache-airflow standalone` and `pipx run apache-airflow standalone`. No extras, 
no version variables, no constraint URL.
   3. **Install into a virtual environment** (optional) — `AIRFLOW_HOME`, then 
`uv` / `pip` tabs that create a venv and install `apache-airflow==|version|` 
with `PYTHON_VERSION` detection and `--constraint`. Extras are omitted. Then 
`airflow standalone`.
   4. **Open the UI** — `http://localhost:8080`, password file 
`$AIRFLOW_HOME/simple_auth_manager_passwords.json.generated`, enable 
`example_bash_operator`.
   5. **Optional check** — a single `airflow tasks test` command. Backfill is 
gone from this page.
   6. **What's next** — tutorial, PyPI install (constraints / extras / other 
tools), Docker Compose / Helm, running components separately, production 
deployment, howto.
   
   
**[airflow-core/docs/installation/index.rst](airflow-core/docs/installation/index.rst)**
   
   - The “Local start” section no longer duplicates the `uvx` / `pipx` 
one-liners; it points at Quick Start.
   - New **Starting components separately** section holds `airflow db migrate`, 
`api-server`, `scheduler`, `dag-processor`, and `triggerer`. `airflow users 
create` stays in a FAB-only note, not as the default Airflow 3 path.
   
   
**[airflow-core/docs/installation/installing-from-pypi.rst](airflow-core/docs/installation/installing-from-pypi.rst)**
   
   - One-line pointer back to Quick Start for a first local run.
   
   ### Why we did not recommend bare `pip install apache-airflow`
   
   The issue asked for an unpinned install on the Quick Start page. The PyPI 
install docs already explain that Airflow keeps dependencies open in 
`pyproject.toml`, so a bare install can fail or produce a broken environment. 
The compromise is:
   
   - lead with `uvx` / `pipx` standalone (already official on the installation 
index)
   - keep constraints on the persistent venv path, but use `|version|` 
substitution so pins stop going stale
   - drop extras from Quick Start (`[celery]` is not needed for standalone)
   - show `pip` and `uv` as full copyable commands instead of “add `uv` to the 
front”
   
   Constraint, extras, and Poetry / pip-tools material stay on the PyPI install 
page, where they already live.
   
   closes: #62298
   
   ## Test plan
   
   - [x] `prek` on the three RST files
   - [x] `breeze build-docs apache-airflow --docs-only --one-pass-only` — 
rendered tabs, `AIRFLOW_VERSION` substitutes (3.4.0 on this tree), links to 
prerequisites / PyPI / starting-components-separately resolve
   - [ ] Skim the rendered Quick Start and confirm every command has a copy 
button and there is no leftover `EXTRAS` / `3.0.0` / `3.1.1`
   - [ ] Confirm `#72753` (UI docs links) is unchanged and does not include 
these files
   
   ---
   
   ##### Was generative AI tooling used to co-author this PR?
   
   - [X] Yes — Cursor Grok 4.6
   
   Generated-by: Cursor Grok 4.6 following [the 
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
   
   
   Made with [Cursor](https://cursor.com)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to