-
Notifications
You must be signed in to change notification settings - Fork 31
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
@ #563 | update window docs #577
Conversation
d498210
to
66c9475
Compare
@hoavt I've applied your comments, pls check again |
docs/getting_started.rst
Outdated
|
||
Manual Installation on Windows | ||
------------------------------ | ||
|
||
1. Install ``git``: | ||
|
||
Head over to https://git-scm.com/downloads and download their latest release, and follow the install instruction, by then you will have ``Git Bash`` already installed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
installation instruction
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
applied
docs/getting_started.rst
Outdated
|
||
2. Install ``virtualbox``: | ||
|
||
Head over to https://www.virtualbox.org/ and download their latest release, and follow the install instruction, by then you will have ``virtualbox`` already installed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
installation instruction
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
applied
docs/getting_started.rst
Outdated
|
||
3. Install ``vagrant``: | ||
|
||
Head over to https://www.vagrantup.com/ and download their latest release, and follow the install instruction, by then you will have ``vagrant`` already installed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
installation instruction
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
applied
docs/getting_started.rst
Outdated
|
||
Manual Installation on Windows | ||
------------------------------ | ||
|
||
1. Install ``git``: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Install Git Bash
:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no it is git
, Git Bash
is included in git
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@datphan please check my comments.
docs/getting_started.rst
Outdated
|
||
.. code-block:: bash | ||
download [rsync-3.1](http://www2.futureware.at/~nickoe/msys2-mirror/msys/x86_64/rsync-3.1.2-2-x86_64.pkg.tar.xz) at http://www2.futureware.at/~nickoe/msys2-mirror/msys/x86_64/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should have the bullet for this section:
-
Download rsync-3.1 at http://www2.futureware.at/~nickoe/msys2-mirror/msys/x86_64/
-
Extract and copy
rsync.exe
toC:\Program Files\Git\usr\bin
, then re-open your terminal window.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
applied
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@datphan please check my comments.
docs/getting_started.rst
Outdated
@@ -147,11 +146,30 @@ Automatic Installation on Windows | |||
|
|||
// TODO(hoatle): add this | |||
|
|||
.. _manual-installation-on-windows: | |||
|
|||
Manual Installation on Windows | |||
------------------------------ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use chocolatey
so that users can copy + paste commands to install required packages.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
applied, pls check again
assigned to @hoavt to continue reviewing. |
docs/getting_started.rst
Outdated
3. Install ``vagrant``: | ||
After the installation is finished, restart the machine. | ||
|
||
2. Install ``git``: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should mention which versions of git, vagrant, virtualbox are accepted.
docs/getting_started.rst
Outdated
|
||
2. Install ``git``: | ||
|
||
Head over to https://git-scm.com/downloads then follow their installation instruction or use: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that instruction to install with the command below is enough for users.
docs/getting_started.rst
Outdated
|
||
2. Install ``git``: | ||
|
||
Head over to https://git-scm.com/downloads then follow their installation instruction or use: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this line
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@datphan please check my comments.
@ teracyhq#563 | apply comments @ teracyhq#563 | fix typo @ teracyhq#563 | apply comments @ teracyhq#563 | use choco @ teracyhq#563 | add window docs
@hoavt applied your comments, pls check again |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not yet to deprecate the cygwin stuff, we're adding git bash and must use it for a while to see if it's better. Until it's proven, we'll decide to depreciate then.
docs/getting_started.rst
Outdated
|
||
- ~~On Windows, you must always use ``Cygwin Terminal``, not ``Git Bash``~~. | ||
|
||
- ``Cygwin Terminal`` is now deprecated and no longer support, we are now using ``Git Bash`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not yet deprecated, we're supporting both at the moment. We'll decide to depreciate only when Git Bash is proven to be better and stable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
applied, pls check again, thanks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@datphan please check my comments.
bacbdab
to
83e1312
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
connect #563