You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "bbovenzi (via GitHub)" <gi...@apache.org> on 2024/08/30 18:02:49 UTC
[PR] Update UI contributing docs [airflow]
bbovenzi opened a new pull request, #41903:
URL: https://github.com/apache/airflow/pull/41903
Add docs on how to run the new `airflow/ui` project. And add temporary rules during Airflow 3.0 development, specifying when to contribute to the new `airflow/ui` and `airflow/ui_api` projects vs the legacy `airflow/www` UI and endpoints.
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update UI contributing docs [airflow]
Posted by "jscheffl (via GitHub)" <gi...@apache.org>.
jscheffl commented on code in PR #41903:
URL: https://github.com/apache/airflow/pull/41903#discussion_r1739313947
##########
contributing-docs/14_node_environment_setup.rst:
##########
@@ -18,6 +18,64 @@
Node.js Environment Setup
=========================
+Contributing to the UI in Airflow
+-----------------------------------------
Review Comment:
Too short, must be: :-D
```suggestion
Contributing to the UI in Airflow
---------------------------------
```
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update UI contributing docs [airflow]
Posted by "jscheffl (via GitHub)" <gi...@apache.org>.
jscheffl commented on code in PR #41903:
URL: https://github.com/apache/airflow/pull/41903#discussion_r1739409511
##########
contributing-docs/14_node_environment_setup.rst:
##########
@@ -18,6 +18,64 @@
Node.js Environment Setup
=========================
+Contributing to the UI in Airflow
Review Comment:
I wanted to try and also found the docs in `airflow/ui/CONTRIBUTING.md` - does it make sense to cross-link here and remove the redundancy?
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update UI contributing docs [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #41903:
URL: https://github.com/apache/airflow/pull/41903#issuecomment-2322251491
Nice. Other than the comments from @jscheffl and @kaxil -> no more from me.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update UI contributing docs [airflow]
Posted by "jscheffl (via GitHub)" <gi...@apache.org>.
jscheffl commented on code in PR #41903:
URL: https://github.com/apache/airflow/pull/41903#discussion_r1739316361
##########
contributing-docs/14_node_environment_setup.rst:
##########
@@ -18,6 +18,64 @@
Node.js Environment Setup
=========================
+Contributing to the UI in Airflow
+-----------------------------------------
+
+In Airflow 3, we are moving the UI away from Flask App Builder views to a pure React powered frontend living at ``airflow/ui``.
+During 3.0 development, we will need to run both the new and legacy UIs at the same time until the new UI is feature-complete.
+But we want to limit modifications to the legacy ``airflow/www`` views, to mainly three rules:
+
+1. Bug fixes to cherry pick for 2.10.x and 2.11
+2. The minimum necessary to unblock other Airflow 3.0 feature work
+3. Fixes to react views which we haven't migrated over yet, but can still be ported over to the new UI
+
+Custom endpoints for the UI will also be moved away from ``airflow/www/views.py`` and to ``airflow/api_ui``.
+Contributions to the legacy views file will follow the same rules.
+Committers will exercise their judgement on what endpoints should exist in the public ``airflow/api_connexion`` versus the private ``airflow/api_ui``
+
+Airflow UI
+-----------------------------------------
+
+``airflow/ui`` is our React frontend powered by Vite with dependencies managed by pnpm.
+Make sure you are using recent versions of pnpm\>=9 and node/>=20. ``breeze start-airflow`` will build the UI automatically.
+Adding the ``--dev-mode`` flag will automatically run the vite dev server for hot reloading the UI during local development.
+
+pnpm commands
+-----------------------------------------
Review Comment:
Right length is:
```suggestion
pnpm commands
-------------
```
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update UI contributing docs [airflow]
Posted by "jscheffl (via GitHub)" <gi...@apache.org>.
jscheffl commented on code in PR #41903:
URL: https://github.com/apache/airflow/pull/41903#discussion_r1739315072
##########
contributing-docs/14_node_environment_setup.rst:
##########
@@ -18,6 +18,64 @@
Node.js Environment Setup
=========================
+Contributing to the UI in Airflow
+-----------------------------------------
+
+In Airflow 3, we are moving the UI away from Flask App Builder views to a pure React powered frontend living at ``airflow/ui``.
+During 3.0 development, we will need to run both the new and legacy UIs at the same time until the new UI is feature-complete.
+But we want to limit modifications to the legacy ``airflow/www`` views, to mainly three rules:
+
+1. Bug fixes to cherry pick for 2.10.x and 2.11
+2. The minimum necessary to unblock other Airflow 3.0 feature work
+3. Fixes to react views which we haven't migrated over yet, but can still be ported over to the new UI
+
+Custom endpoints for the UI will also be moved away from ``airflow/www/views.py`` and to ``airflow/api_ui``.
+Contributions to the legacy views file will follow the same rules.
+Committers will exercise their judgement on what endpoints should exist in the public ``airflow/api_connexion`` versus the private ``airflow/api_ui``
+
+Airflow UI
+-----------------------------------------
+
+``airflow/ui`` is our React frontend powered by Vite with dependencies managed by pnpm.
Review Comment:
Also asked myself about this and first thought I'm too stupid. THanks Kaxil for asking :-D (I was too shy)
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update UI contributing docs [airflow]
Posted by "bbovenzi (via GitHub)" <gi...@apache.org>.
bbovenzi merged PR #41903:
URL: https://github.com/apache/airflow/pull/41903
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update UI contributing docs [airflow]
Posted by "kaxil (via GitHub)" <gi...@apache.org>.
kaxil commented on code in PR #41903:
URL: https://github.com/apache/airflow/pull/41903#discussion_r1739301101
##########
contributing-docs/14_node_environment_setup.rst:
##########
@@ -18,6 +18,64 @@
Node.js Environment Setup
=========================
+Contributing to the UI in Airflow
+-----------------------------------------
Review Comment:
```suggestion
Contributing to the UI in Airflow
--------------------------------
```
##########
contributing-docs/14_node_environment_setup.rst:
##########
@@ -18,6 +18,64 @@
Node.js Environment Setup
=========================
+Contributing to the UI in Airflow
+-----------------------------------------
+
+In Airflow 3, we are moving the UI away from Flask App Builder views to a pure React powered frontend living at ``airflow/ui``.
+During 3.0 development, we will need to run both the new and legacy UIs at the same time until the new UI is feature-complete.
+But we want to limit modifications to the legacy ``airflow/www`` views, to mainly three rules:
+
+1. Bug fixes to cherry pick for 2.10.x and 2.11
+2. The minimum necessary to unblock other Airflow 3.0 feature work
+3. Fixes to react views which we haven't migrated over yet, but can still be ported over to the new UI
+
+Custom endpoints for the UI will also be moved away from ``airflow/www/views.py`` and to ``airflow/api_ui``.
+Contributions to the legacy views file will follow the same rules.
+Committers will exercise their judgement on what endpoints should exist in the public ``airflow/api_connexion`` versus the private ``airflow/api_ui``
+
+Airflow UI
+-----------------------------------------
+
+``airflow/ui`` is our React frontend powered by Vite with dependencies managed by pnpm.
Review Comment:
What's Vite? Is it https://vitejs.dev/ ?
##########
contributing-docs/14_node_environment_setup.rst:
##########
@@ -18,6 +18,64 @@
Node.js Environment Setup
=========================
+Contributing to the UI in Airflow
+-----------------------------------------
+
+In Airflow 3, we are moving the UI away from Flask App Builder views to a pure React powered frontend living at ``airflow/ui``.
+During 3.0 development, we will need to run both the new and legacy UIs at the same time until the new UI is feature-complete.
+But we want to limit modifications to the legacy ``airflow/www`` views, to mainly three rules:
+
+1. Bug fixes to cherry pick for 2.10.x and 2.11
+2. The minimum necessary to unblock other Airflow 3.0 feature work
+3. Fixes to react views which we haven't migrated over yet, but can still be ported over to the new UI
+
+Custom endpoints for the UI will also be moved away from ``airflow/www/views.py`` and to ``airflow/api_ui``.
+Contributions to the legacy views file will follow the same rules.
+Committers will exercise their judgement on what endpoints should exist in the public ``airflow/api_connexion`` versus the private ``airflow/api_ui``
+
+Airflow UI
+-----------------------------------------
+
+``airflow/ui`` is our React frontend powered by Vite with dependencies managed by pnpm.
+Make sure you are using recent versions of pnpm\>=9 and node/>=20. ``breeze start-airflow`` will build the UI automatically.
Review Comment:
```suggestion
Make sure you are using recent versions of ``pnpm>=9`` and ``node>=20``. ``breeze start-airflow`` will build the UI automatically.
```
##########
contributing-docs/14_node_environment_setup.rst:
##########
@@ -18,6 +18,64 @@
Node.js Environment Setup
=========================
+Contributing to the UI in Airflow
+-----------------------------------------
+
+In Airflow 3, we are moving the UI away from Flask App Builder views to a pure React powered frontend living at ``airflow/ui``.
+During 3.0 development, we will need to run both the new and legacy UIs at the same time until the new UI is feature-complete.
+But we want to limit modifications to the legacy ``airflow/www`` views, to mainly three rules:
+
+1. Bug fixes to cherry pick for 2.10.x and 2.11
+2. The minimum necessary to unblock other Airflow 3.0 feature work
+3. Fixes to react views which we haven't migrated over yet, but can still be ported over to the new UI
+
+Custom endpoints for the UI will also be moved away from ``airflow/www/views.py`` and to ``airflow/api_ui``.
+Contributions to the legacy views file will follow the same rules.
+Committers will exercise their judgement on what endpoints should exist in the public ``airflow/api_connexion`` versus the private ``airflow/api_ui``
+
+Airflow UI
+-----------------------------------------
+
+``airflow/ui`` is our React frontend powered by Vite with dependencies managed by pnpm.
+Make sure you are using recent versions of pnpm\>=9 and node/>=20. ``breeze start-airflow`` will build the UI automatically.
+Adding the ``--dev-mode`` flag will automatically run the vite dev server for hot reloading the UI during local development.
+
+pnpm commands
+-----------------------------------------
Review Comment:
```suggestion
pnpm commands
-----------------
```
##########
contributing-docs/14_node_environment_setup.rst:
##########
@@ -18,6 +18,64 @@
Node.js Environment Setup
=========================
+Contributing to the UI in Airflow
+-----------------------------------------
+
+In Airflow 3, we are moving the UI away from Flask App Builder views to a pure React powered frontend living at ``airflow/ui``.
+During 3.0 development, we will need to run both the new and legacy UIs at the same time until the new UI is feature-complete.
+But we want to limit modifications to the legacy ``airflow/www`` views, to mainly three rules:
+
+1. Bug fixes to cherry pick for 2.10.x and 2.11
+2. The minimum necessary to unblock other Airflow 3.0 feature work
+3. Fixes to react views which we haven't migrated over yet, but can still be ported over to the new UI
+
+Custom endpoints for the UI will also be moved away from ``airflow/www/views.py`` and to ``airflow/api_ui``.
+Contributions to the legacy views file will follow the same rules.
+Committers will exercise their judgement on what endpoints should exist in the public ``airflow/api_connexion`` versus the private ``airflow/api_ui``
+
+Airflow UI
+-----------------------------------------
Review Comment:
```suggestion
Airflow UI
----------
```
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update UI contributing docs [airflow]
Posted by "bbovenzi (via GitHub)" <gi...@apache.org>.
bbovenzi commented on code in PR #41903:
URL: https://github.com/apache/airflow/pull/41903#discussion_r1739397951
##########
contributing-docs/14_node_environment_setup.rst:
##########
@@ -18,6 +18,64 @@
Node.js Environment Setup
=========================
+Contributing to the UI in Airflow
+-----------------------------------------
+
+In Airflow 3, we are moving the UI away from Flask App Builder views to a pure React powered frontend living at ``airflow/ui``.
+During 3.0 development, we will need to run both the new and legacy UIs at the same time until the new UI is feature-complete.
+But we want to limit modifications to the legacy ``airflow/www`` views, to mainly three rules:
+
+1. Bug fixes to cherry pick for 2.10.x and 2.11
+2. The minimum necessary to unblock other Airflow 3.0 feature work
+3. Fixes to react views which we haven't migrated over yet, but can still be ported over to the new UI
+
+Custom endpoints for the UI will also be moved away from ``airflow/www/views.py`` and to ``airflow/api_ui``.
+Contributions to the legacy views file will follow the same rules.
+Committers will exercise their judgement on what endpoints should exist in the public ``airflow/api_connexion`` versus the private ``airflow/api_ui``
+
+Airflow UI
+-----------------------------------------
+
+``airflow/ui`` is our React frontend powered by Vite with dependencies managed by pnpm.
Review Comment:
Added a link and description.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org