docs: Guide for resolving UI TemplateNotFound in Breeze setup #54521
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
|
boring-cyborg
bot
added
area:dev-tools
backport-to-v3-1-test
potiuk
approved these changes
Aug 14, 2025
…eeze setup
This updates the contributor quick start documentation to include a troubleshooting note for the error:
jinja2.exceptions.TemplateNotFound: '/index.html' not found in search path: '/opt/airflow/airflow-core/src/airflow/ui/dist'
The note instructs users to run `breeze compile-ui-assets` before starting the Breeze environment if they encounter this error, and to verify that UI assets are added to `/airflow/.build/ui`. This helps contributors resolve frontend asset issues during initial setup.
Also clarifies the placement of this step relative to existing Breeze initialization instructions.
dataengineervishal
force-pushed
the
docs/fix-breeze-template-notfound-not
branch
from
614b9b9 to
5711847
Compare
Contributor
Author
|
@potiuk This is my first PR. I’ve fixed the lint errors and confirmed that all checks are now passing. Could you please review and approve for merge? Let me know if there’s anything else I should address. |
Lee-W
approved these changes
Aug 15, 2025
|
Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions. |
Backport successfully created: v3-0-test
|
github-actions bot
pushed a commit
to sjyangkevin/airflow
that referenced
this pull request
Aug 15, 2025
…etup (apache#54521) (cherry picked from commit 83f0dc5) Co-authored-by: Vishal <69051998+dataengineervishal@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates the contributor quick start documentation to help users resolve a common issue that can occur when setting up the Breeze environment. Specifically, it adds troubleshooting instructions for the following error:
jinja2.exceptions.TemplateNotFound: '/index.html' not found in search path: '/opt/airflow/airflow-core/src/airflow/ui/dist'The documentation now instructs users to run breeze compile-ui-assets before initializing the Breeze environment if they encounter this error, and to verify that the compiled UI assets are present in /airflow/.build/ui before proceeding.
This addition aims to make the onboarding process smoother and to help new contributors quickly resolve UI asset-related errors during setup.