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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
