[Update] Breeze2-on-windows #20148

edithturn · 2021-12-08T17:26:48Z

According to this issue:
#19992 <- Already merged
Closes #19966

I am adding the documentation to install Breeze2 on windows, with "pipx"

uranusjr · 2021-12-08T17:34:32Z

BREEZE.rst

+.. code-block:: bash
+
+   pipx install -e dev\breeze
+
+If you are using Linux/Bash (POSIX) on Windows, like Git Bash use:
+
+.. code-block:: bash
+
+   pipx install -e dev/breeze


Forward slash works everywhere, including Powershell and cmd.exe, so we don’t need two code blocks here.

does it :) ? Did they learn ?

Yes, they learned. / works for PowerShell, cmd, and Git Bash. Thank you I will fix it.

potiuk · 2021-12-08T21:45:26Z

BREEZE.rst

+
+.. code-block:: bash
+
+   pix ensurepath


Suggested change

pix ensurepath

pipx ensurepath

potiuk · 2021-12-08T21:49:05Z

BREEZE.rst

@@ -265,6 +265,40 @@ You should set up the autocomplete option automatically by running:

 You get the auto-completion working when you re-enter the shell.

+Breeze on Windows


One comment - I think for now we should develop a "parallel documentation. I have not thought about it too much - but I believe for now - until we open Breeze2 for others, we should keep the docs in ./dev/breeze/doc.

I am not 100% sure what will be the best structure there. Should we have a separate "Breeze_install.md" ? Or everything in README.md or something else? Maybe as a 'fresh' user - you could come up with some proposal @edithturn ? . For sure we should not add it to the current Breeze docuementation.

And we should also add docs for other platforms. Actually pipx is not Windows specific. If as @uranusjr says "forward slash" works on Windows. then we could provide universal installation instructions for any OS.

I agree with this, BREEZE.rst documentation is already big. I don't know about the structure yet because I am not familiar with everything, but next week I came come with an idea. For now ./dev/breeze is good.

If I understand correctly all the documentation related to Breeze2 should be in a separate directory, right? If it is like that, I think this directory is good: ./dev/breeze/doc, but we should think about what things we will behave here, For now, I just know we have BREEZE.rst documentation. (Correct me if I am wrong)

potiuk

The docs would be better in ./dev/breeze (see the comment)

edithturn · 2021-12-09T13:50:26Z

The docs would be better in ./dev/breeze (see the comment)
@potiuk I will make a copy of BREEZE.rst with the changes about Windows and I will add it here: ./dev/breeze/docs. Is that okay?

potiuk · 2021-12-09T14:39:29Z

The docs would be better in ./dev/breeze (see the comment)
@potiuk I will make a copy of BREEZE.rst with the changes about Windows and I will add it here: ./dev/breeze/docs. Is that okay?

I think it woudl be better Just start "fresh" the BREEZE documention basicaly has everything but a kitchen sink, and I think it will be better outcome if we start from zero (and maybe move relevant start from Breeze.rst and decide later what to do when we switch.

Actually - I think a simple/standard approach is to have INSTALL.md in the "project" directory. And maybe that's a good starting point ("./dev/breeze/INSTALL.md"). Md is much easier/more lightweight format for documentation and seems to be better suited for that. Unless others have another opinion. @uranusjr WDYT?

edithturn · 2021-12-09T15:19:13Z

I got it @potiuk, I also think .md is easier, and we should try to standardize the documentation too (.md or .rst for new docs) :)

potiuk · 2021-12-09T15:29:51Z

.md it is

edithturn · 2021-12-10T04:10:11Z

@potiuk let me know if this is good: https://github.com/apache/airflow/pull/20148/files
I added BREEZE.md on dev/breeze/doc, this is practically empty, it has just Installation on Windows.
What I am thinking to do is, review and validate all the existing documentation on BREEZE.rst and add on BREEZE.md (which is a lot).
Another thing, I could focus only on information that is not updated, I can go over the documentation and ask you section by section to see if that part of the documentation should be deleted or updated, so just after know that I could add it on BREEZE.md.
Let me know your thoughts.

github-actions · 2021-12-13T21:51:02Z

The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest main or amend the last commit of the PR, and push it with --force-with-lease.

potiuk · 2021-12-13T21:51:03Z

Some static-check erors - needs pre-commit re-run.

edithturn · 2021-12-19T06:36:43Z

Yeah, I will add more things and I will fix it! Thank you:
I am using as a reference another PR: #19966

potiuk · 2021-12-21T19:07:08Z

dev/breeze/doc/BREEZE.md

+```
+To update the installation use: --force
+```bash
+pipx install --force -e <Breeze Folder>


Suggested change

pipx install --force -e <Breeze Folder>

pipx install --force -e dev/breeze

dev/breeze/doc/BREEZE.md

potiuk · 2021-12-28T23:57:25Z

I am afraid you will need to rebase the changes due to conflict @edithturn. We have a nice instructions on rebasing in https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#id15

edithturn · 2021-12-29T04:26:38Z

This part entry: ([\W\s\n\t\r]|^)breeze([\W\s\n\t\r]|$) was added. I will reverse my code.

potiuk · 2022-01-03T16:18:54Z

LGTM

github-actions · 2022-01-03T16:19:15Z

The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.

potiuk · 2022-01-03T16:44:51Z

🎉 🎉 🎉 🎉 🎉 🎉 🎉

edithturn · 2022-01-03T16:46:43Z

wow, I will cry with this, I am really happy to be in Apache Airflow. This was just documentation but in all these processes I learned a lot, thank you @potiuk :')

boring-cyborg bot added the area:dev-tools label Dec 8, 2021

edithturn mentioned this pull request Dec 8, 2021

Breeze: Make Breeze works for Windows seemleasly #19966

Closed

uranusjr reviewed Dec 8, 2021

View reviewed changes

potiuk reviewed Dec 8, 2021

View reviewed changes

BREEZE.rst Outdated

.. code-block:: bash

pix ensurepath

Copy link

Member

potiuk Dec 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

pix ensurepath

pipx ensurepath

potiuk reviewed Dec 8, 2021

View reviewed changes

potiuk requested changes Dec 8, 2021

View reviewed changes

edithturn requested review from ashb, jedcunningham and kaxil as code owners December 10, 2021 03:41

potiuk approved these changes Dec 13, 2021

View reviewed changes

github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Dec 13, 2021

potiuk reviewed Dec 21, 2021

View reviewed changes

dev/breeze/doc/BREEZE.md Show resolved Hide resolved

potiuk reviewed Dec 21, 2021

View reviewed changes

dev/breeze/doc/BREEZE.md Show resolved Hide resolved

potiuk reviewed Dec 21, 2021

View reviewed changes

dev/breeze/doc/BREEZE.md Show resolved Hide resolved

update breeze2 on windows

f23a03c

edithturn force-pushed the update-doc-install-breeze-windows branch from d809239 to f23a03c Compare January 3, 2022 15:51

potiuk approved these changes Jan 3, 2022

View reviewed changes

github-actions bot added the full tests needed We need to run full set of tests for this PR to merge label Jan 3, 2022

potiuk merged commit 9db894a into apache:main Jan 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Update] Breeze2-on-windows #20148

[Update] Breeze2-on-windows #20148

edithturn commented Dec 8, 2021 •

edited

Loading

uranusjr Dec 8, 2021

potiuk Dec 8, 2021

edithturn Dec 9, 2021

potiuk Dec 8, 2021

potiuk Dec 8, 2021

potiuk Dec 8, 2021

edithturn Dec 9, 2021

edithturn Dec 9, 2021

potiuk left a comment

edithturn commented Dec 9, 2021

potiuk commented Dec 9, 2021

edithturn commented Dec 9, 2021

potiuk commented Dec 9, 2021

edithturn commented Dec 10, 2021

github-actions bot commented Dec 13, 2021

potiuk commented Dec 13, 2021

edithturn commented Dec 19, 2021

potiuk Dec 21, 2021

potiuk commented Dec 28, 2021

edithturn commented Dec 29, 2021

potiuk commented Jan 3, 2022

github-actions bot commented Jan 3, 2022

potiuk commented Jan 3, 2022

edithturn commented Jan 3, 2022

		@@ -265,6 +265,40 @@ You should set up the autocomplete option automatically by running:

		You get the auto-completion working when you re-enter the shell.

		Breeze on Windows

	pipx install --force -e <Breeze Folder>
	pipx install --force -e dev/breeze

[Update] Breeze2-on-windows #20148

[Update] Breeze2-on-windows #20148

Conversation

edithturn commented Dec 8, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

potiuk left a comment

Choose a reason for hiding this comment

edithturn commented Dec 9, 2021

potiuk commented Dec 9, 2021

edithturn commented Dec 9, 2021

potiuk commented Dec 9, 2021

edithturn commented Dec 10, 2021

github-actions bot commented Dec 13, 2021

potiuk commented Dec 13, 2021

edithturn commented Dec 19, 2021

Choose a reason for hiding this comment

potiuk commented Dec 28, 2021

edithturn commented Dec 29, 2021

potiuk commented Jan 3, 2022

github-actions bot commented Jan 3, 2022

potiuk commented Jan 3, 2022

edithturn commented Jan 3, 2022

edithturn commented Dec 8, 2021 •

edited

Loading