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

@ #563 | update window docs #577

Merged
merged 2 commits into from
Jan 17, 2019
Merged

@ #563 | update window docs #577

merged 2 commits into from
Jan 17, 2019

Conversation

datphan
Copy link
Contributor

@datphan datphan commented Dec 17, 2018

connect #563

@ghost ghost assigned datphan Dec 17, 2018
@ghost ghost added the stag:under-review label Dec 17, 2018
@datphan datphan requested review from hoavt and hoatle and removed request for hoavt December 17, 2018 10:51
docs/getting_started.rst Outdated Show resolved Hide resolved
docs/getting_started.rst Outdated Show resolved Hide resolved
@datphan datphan force-pushed the update_docs branch 6 times, most recently from d498210 to 66c9475 Compare December 25, 2018 03:22
@datphan
Copy link
Contributor Author

datphan commented Dec 25, 2018

@hoavt I've applied your comments, pls check again


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.
Copy link
Contributor

Choose a reason for hiding this comment

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

installation instruction

Copy link
Contributor Author

Choose a reason for hiding this comment

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

applied


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.
Copy link
Contributor

Choose a reason for hiding this comment

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

installation instruction

Copy link
Contributor Author

Choose a reason for hiding this comment

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

applied


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.
Copy link
Contributor

Choose a reason for hiding this comment

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

installation instruction

Copy link
Contributor Author

Choose a reason for hiding this comment

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

applied


Manual Installation on Windows
------------------------------

1. Install ``git``:
Copy link
Contributor

Choose a reason for hiding this comment

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

Install Git Bash:

Copy link
Contributor Author

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

Copy link
Contributor

@hoavt hoavt left a 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.


.. 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/
Copy link
Contributor

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:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

applied

hoavt
hoavt previously approved these changes Dec 25, 2018
hoatle
hoatle previously requested changes Dec 25, 2018
Copy link
Member

@hoatle hoatle left a 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.

@@ -147,11 +146,30 @@ Automatic Installation on Windows

// TODO(hoatle): add this

.. _manual-installation-on-windows:

Manual Installation on Windows
------------------------------
Copy link
Member

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

applied, pls check again

@hoatle
Copy link
Member

hoatle commented Jan 8, 2019

assigned to @hoavt to continue reviewing.

3. Install ``vagrant``:
After the installation is finished, restart the machine.

2. Install ``git``:
Copy link
Contributor

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.


2. Install ``git``:

Head over to https://git-scm.com/downloads then follow their installation instruction or use:
Copy link
Contributor

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.


2. Install ``git``:

Head over to https://git-scm.com/downloads then follow their installation instruction or use:
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove this line

Copy link
Contributor

@hoavt hoavt left a 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
@datphan
Copy link
Contributor Author

datphan commented Jan 15, 2019

@hoavt applied your comments, pls check again

hoavt
hoavt previously approved these changes Jan 15, 2019
Copy link
Member

@hoatle hoatle left a 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 Show resolved Hide resolved

- ~~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``
Copy link
Member

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.

Copy link
Contributor Author

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

docs/getting_started.rst Outdated Show resolved Hide resolved
docs/getting_started.rst Outdated Show resolved Hide resolved
Copy link
Member

@hoatle hoatle left a 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.

@datphan datphan force-pushed the update_docs branch 2 times, most recently from bacbdab to 83e1312 Compare January 17, 2019 03:20
Copy link
Member

@hoatle hoatle left a comment

Choose a reason for hiding this comment

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

LGTM

@hoatle hoatle merged commit 8de30f9 into teracyhq:develop Jan 17, 2019
@ghost ghost removed the stag:under-review label Jan 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants