Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix and simplify build instructions for Windows #2612

Closed
wants to merge 1 commit into from

Conversation

adamretter
Copy link
Contributor

@adamretter adamretter commented Aug 18, 2018

Closes #1614
Also relevant #2009

@adamretter adamretter changed the title Don't install wrong yarn version first on Windows Fix and simplify build instructions for Windows Aug 18, 2018
@akosyakov akosyakov requested a review from kittaakos August 18, 2018 07:59
@kittaakos
Copy link
Contributor

I am reviewing it now...

Also relevant #2009

Why is it relevant?

@adamretter, please sign your commit. Otherwise, we cannot accept it.

Copy link
Contributor

@kittaakos kittaakos left a comment

Choose a reason for hiding this comment

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

I did not have the chance to try it out from scratch; I have everything already installed on Windows. I never use cmd.exe anyway, but the documentation looks good. Thank you for your help!

I have made a few recommendations, if you have questions, please ask.

@@ -235,33 +235,61 @@ etc.) by opening `packages/<package name>/coverage/index.html`.

## Building on Windows

Run cmd.exe as an administrator and install `choco` by copy-pasting the command
to your console:
1. Run cmd.exe as an Administrator. You can do this by right-clicking "Command Prompt" in the Windows Start Menu, and then right-clicking "Run as Administrator".
Copy link
Contributor

Choose a reason for hiding this comment

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

You can do this by right-clicking "Command Prompt" in the Windows Start Menu

I must be blind, where is the "Command Prompt'?

screen shot 2018-08-31 at 10 03 00

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Which version of Windows do you have? Mine looks significantly different to that...

Copy link
Contributor

Choose a reason for hiding this comment

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

Windows 10 Pro.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am also using Windows 10 Pro N. It looks very different to yours however -
virtualbox_windows 10_31_08_2018_14_50_42

Copy link
Contributor

Choose a reason for hiding this comment

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

😄 I was confused. I did the right click on the Start Menu. Great, then it is OK.
By the way there is another way without clicking: https://superuser.com/questions/968214/open-cmd-as-admin-with-windowsr-shortcut

  • Win+R
  • Type: cmd.
  • Alt+Ctrl+Enter

Copy link

Choose a reason for hiding this comment

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

There is one small mistake here in the choco command for yarn. You should use the -i option to ignore dependencies or you will find that yarn will install Node 10+ as well, overriding your initial Node LTS install.

refreshenv
```

4. Install NodeJS via. choco (**NOTE**: the version is important!) by running the following in the Command Prompt:
Copy link
Contributor

Choose a reason for hiding this comment

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

NodeJS -> Node.js

choco install yarn --version 1.7.0 -y
```

6. Install Git via. Choco:
Copy link
Contributor

Choose a reason for hiding this comment

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

Choco -> choco (or choco).

Please if you escape something or put it between the double quotes, use it consistently.
"Command Prompt", Command Prompt
Choco, choco, choco.

choco install git

Install the correct version of `yarn` (The version is important)
2. Install `choco` by copy and pasting the command below into the Command Prompt, and then pressing the `return` key to run it:
Copy link
Contributor

Choose a reason for hiding this comment

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

`return`

return

<kbd>return</kbd>

return

@adamretter
Copy link
Contributor Author

#2009 is relevant because it states that Theia does not run on Node v10.3.0. This PR ensures that Node.js 8.11.4 is used.

@kittaakos
Copy link
Contributor

#2009 is relevant because it states that Theia does not run on Node v10.3.0. This PR ensures that Node.js 8.11.4 is used.

I see. I thought you're considering this PR as a fix of #2009.

@adamretter adamretter force-pushed the patch-1 branch 2 times, most recently from b7d3de8 to 52dfab7 Compare August 31, 2018 09:17
@adamretter
Copy link
Contributor Author

@kittaakos Okay, I made the changes you asked for, rebased and signed the commits.

@kittaakos
Copy link
Contributor

I made the changes you asked for

Awesome! What about the "Command Prompt" in the Windows Start Menu, and then right-clicking "Run as Administrator". As you can see, I do not have such an option.

rebased and signed the commits.

You need to squash the commits and sign it. Make sure you use the same email address as your GH account has.

@dunnry
Copy link

dunnry commented Sep 20, 2018

I would update the instructions to include the -i flag when installing yarn from chocolatey. This tells chocolatey to not install node again. If you forget this flag, it will likely pull in Node 10+ as well.

@adamretter
Copy link
Contributor Author

adamretter commented Nov 1, 2018

@kittaakos okay I fixed the run as Administrator thing and squashed and signed the commits.

@dunnry I did not add the -i option as my process from start to finish without that worked fine for me. Perhaps it is better done in a subsequent PR where someone can test it on a clean system?

… be done from cmd.exe (don't need different shells)

Closes eclipse-theia#1614
See also eclipse-theia#2009

Signed-off-by: Adam Retter <adam.retter@googlemail.com>
@kittaakos
Copy link
Contributor

For committers/reviewers:

There is a valid ECA on file for adam.retter@googlemail.com.

@vince-fugnitto
Copy link
Member

@adamretter do you still plan on amending the PR in order for it to be merged?
I understand that the PR has been in review for quite a while now and perhaps it is outdated (there are conflicts at the moment).

@vince-fugnitto vince-fugnitto added documentation issues related to documentation OS/Windows issues related to the Windows OS labels Nov 26, 2019
@vince-fugnitto
Copy link
Member

I'll be closing the PR for the moment due to inactivity :(
@adamretter please re-open the PR if you ever get a chance to update and resolve the issues, we'd love to have better and simpler documentation regarding build instructions for Windows.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to documentation OS/Windows issues related to the Windows OS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Possible improvements in the Windows building documentation
4 participants