romsharon98 commented on code in PR #45133:
URL: https://github.com/apache/airflow/pull/45133#discussion_r1895768107
##########
contributing-docs/03_contributors_quick_start.rst:
##########
@@ -82,23 +82,27 @@ Docker Community Edition
.. code-block:: bash
sudo apt-get update
- sudo apt-get install docker-ce docker-ce-cli containerd.io
docker-compose-plugin
+ sudo apt-get install docker-ce docker-ce-cli containerd.io
Review Comment:
The title of this section should change to `2. Install Docker Engine,
containerd`
##########
contributing-docs/03_contributors_quick_start.rst:
##########
@@ -209,8 +225,8 @@ Set it to true for windows.
git config core.autocrlf true
-Typical development tasks
-#########################
+Setting up Breeze
+-----------------
Review Comment:
```suggestion
#################
```
##########
contributing-docs/03_contributors_quick_start.rst:
##########
@@ -500,7 +511,7 @@ on macOS, install via
brew install libxml2
-2. Installing pre-commit (if you have not done it yet):
+2. Installing pre-commit:
Review Comment:
I think better remove this section of install pre-commit using uv and keep
the upper section, to have a flow of how to install pre-commit properly
##########
contributing-docs/03_contributors_quick_start.rst:
##########
@@ -315,7 +327,10 @@ Using Breeze
1. Starting breeze environment using ``breeze start-airflow`` starts Breeze
environment with last configuration run(
In this case python and backend will be picked up from last execution
``breeze --python 3.9 --backend postgres``)
It also automatically starts webserver, backend and scheduler. It drops you
in tmux with scheduler in bottom left
- and webserver in bottom right. Use ``[Ctrl + B] and Arrow keys`` to navigate
+ and webserver in bottom right. Use ``[Ctrl + B] and Arrow keys`` to
navigate.
+ Keep in mind, you need ``pre-commit`` installed for this to work or you
will be prompted with
+ ``FileNotFoundError: [Errno 2] No such file or directory: 'pre-commit'``
+ when attempting to invoke ``breeze start-airflow``.
Review Comment:
I think adding a link to how install pre-commit will be nice
##########
contributing-docs/03_contributors_quick_start.rst:
##########
@@ -414,12 +429,22 @@ Using Breeze
4. Stopping breeze
+If Airflow was started with ``breeze start-airflow``:
+
.. code-block:: bash
root@f3619b74c59a:/opt/airflow# stop_airflow
+ breeze down
+
+If Airflow was started with ``breeze --python 3.9 --backend postgres``:
Review Comment:
running breeze does not start airflow so I don't think this section is needed
--
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]
