[v3-1-test] Improve documentation and behaviour of mprocs (#58718) - #58798
Merged
Conversation
The AI-generated documentation had some hallucinations and had a bit of duplication and chattines. Also it was not clear you can also easily run mprocs outside of breeze in regular terminal (you can !) and how to do it easily. This is all corrected here: * README.md is removed (most of the content was in QUICK REFERENCE or was just too chatty * Hallucinated keybindings were corrected * basic.yaml is now simply mprocs.yml so that you can use it directly in the contributing-docs/mprocs folder without specifying config file * we are using now uv to run generate_mprocs_config.py and it has inline requirements specified - making it easily usable outside of breeze environment * removed replacement of local executor that is not needed any more also in run_mprocs * added some non-obvious but useful key bindings in the guide * the generated mprocs.yaml is now created in /files when run with start-airflow which makes it directly usable outside of Breeze. * there are some caveats of mprocs working with iTerm2 on MacOS, this change documents workaround/solution needed to work with mprocs until better solutions are found (cherry picked from commit d1bd555) Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
potiuk
marked this pull request as ready for review
November 28, 2025 02:07
potiuk
requested review from
amoghrajesh,
ashb,
bugraoz93,
eladkal,
gopidesupavan,
jason810496,
jscheffl,
kaxil and
potiuk
as code owners
November 28, 2025 02:07
ephraimbuddy
added
the
changelog:skip
ephraimbuddy
pushed a commit
that referenced
this pull request
Dec 3, 2025
…58798) The AI-generated documentation had some hallucinations and had a bit of duplication and chattines. Also it was not clear you can also easily run mprocs outside of breeze in regular terminal (you can !) and how to do it easily. This is all corrected here: * README.md is removed (most of the content was in QUICK REFERENCE or was just too chatty * Hallucinated keybindings were corrected * basic.yaml is now simply mprocs.yml so that you can use it directly in the contributing-docs/mprocs folder without specifying config file * we are using now uv to run generate_mprocs_config.py and it has inline requirements specified - making it easily usable outside of breeze environment * removed replacement of local executor that is not needed any more also in run_mprocs * added some non-obvious but useful key bindings in the guide * the generated mprocs.yaml is now created in /files when run with start-airflow which makes it directly usable outside of Breeze. * there are some caveats of mprocs working with iTerm2 on MacOS, this change documents workaround/solution needed to work with mprocs until better solutions are found (cherry picked from commit d1bd555) Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
The AI-generated documentation had some hallucinations and had a bit
of duplication and chattines. Also it was not clear you can also easily
run mprocs outside of breeze in regular terminal (you can !) and how to
do it easily.
This is all corrected here:
README.md is removed (most of the content was in QUICK REFERENCE or
was just too chatty
Hallucinated keybindings were corrected
basic.yaml is now simply mprocs.yml so that you can use it directly
in the contributing-docs/mprocs folder without specifying config file
we are using now uv to run generate_mprocs_config.py and it has
inline requirements specified - making it easily usable outside of
breeze environment
removed replacement of local executor that is not needed any more
also in run_mprocs
added some non-obvious but useful key bindings in the guide
the generated mprocs.yaml is now created in /files when run with
start-airflow which makes it directly usable outside of Breeze.
there are some caveats of mprocs working with iTerm2 on MacOS, this
change documents workaround/solution needed to work with mprocs until
better solutions are found
(cherry picked from commit d1bd555)
Co-authored-by: Jarek Potiuk jarek@potiuk.com