This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 3d89797889 doc: breeze instruction - "where to run" `pipx install` cmd
(#28709)
3d89797889 is described below
commit 3d89797889e43bda89d4ceea37130bdfbc3db32c
Author: Michal Niemiec <[email protected]>
AuthorDate: Wed Jan 4 11:46:58 2023 +0100
doc: breeze instruction - "where to run" `pipx install` cmd (#28709)
* Including explicit information on "where to run" `pipx install` command
from.
`pipx` is normally used to install packages from pypi as cli, so to some
users it's non-obvious that we look to install a tool that is part of apache
airflow project/repo
---
BREEZE.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 89fab567cf..35a84ccb6f 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -223,6 +223,7 @@ In case of disk space errors on macOS, increase the disk
space available for Doc
Installation
============
+Set your working directory to root of (this) cloned repository.
Run this command to install Breeze (make sure to use ``-e`` flag):
.. code-block:: bash
@@ -239,7 +240,7 @@ Those are all available commands for Breeze and details
about the commands are d
:width: 100%
:alt: Breeze commands
-Breeze installed this way is linked to your checked out sources of Airflow so
Breeze will
+Breeze installed this way is linked to your checked out sources of Airflow, so
Breeze will
automatically use latest version of sources from ``./dev/breeze``. Sometimes,
when dependencies are
updated ``breeze`` commands with offer you to run self-upgrade.
