mirror of https://github.com/zulip/zulip.git
docs: Update recommendations of Windows installation methods.
This change attempts to highlight WSL 2 as the default installation method for Windows; that is currently much more reliable than Vagrant. Further work is probably needed to complete this transition.
This commit is contained in:
parent
901ee36706
commit
bc6570eb67
|
@ -81,4 +81,4 @@ machine, take a look at our tips for
|
||||||
[using-dev-env]: using.md
|
[using-dev-env]: using.md
|
||||||
[testing]: ../testing/testing.md
|
[testing]: ../testing/testing.md
|
||||||
[ci]: ../git/cloning.html#step-3-configure-continuous-integration-for-your-fork
|
[ci]: ../git/cloning.html#step-3-configure-continuous-integration-for-your-fork
|
||||||
[install-via-wsl]: ../development/setup-advanced.html#installing-directly-on-windows-10-experimental
|
[install-via-wsl]: ../development/setup-advanced.html#installing-directly-on-windows-10-with-wsl-2
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
* [Installing directly on Ubuntu, Debian, CentOS, or Fedora](#installing-directly-on-ubuntu-debian-centos-or-fedora)
|
* [Installing directly on Ubuntu, Debian, CentOS, or Fedora](#installing-directly-on-ubuntu-debian-centos-or-fedora)
|
||||||
* [Installing directly on Windows 10](#installing-directly-on-windows-10-experimental)
|
* [Installing directly on Windows 10 with WSL 2](#installing-directly-on-windows-10-with-wsl-2)
|
||||||
* [Using the Vagrant Hyper-V provider on Windows](#using-the-vagrant-hyper-v-provider-on-windows-beta)
|
* [Using the Vagrant Hyper-V provider on Windows](#using-the-vagrant-hyper-v-provider-on-windows-beta)
|
||||||
* [Newer versions of supported platforms](#newer-versions-of-supported-platforms)
|
* [Newer versions of supported platforms](#newer-versions-of-supported-platforms)
|
||||||
* [Installing directly on cloud9](#installing-on-cloud9)
|
* [Installing directly on cloud9](#installing-on-cloud9)
|
||||||
|
@ -57,19 +57,17 @@ on using the Zulip development
|
||||||
environment](../development/setup-vagrant.html#step-4-developing),
|
environment](../development/setup-vagrant.html#step-4-developing),
|
||||||
ignoring the parts about `vagrant` (since you're not using it).
|
ignoring the parts about `vagrant` (since you're not using it).
|
||||||
|
|
||||||
## Installing directly on Windows 10 (experimental)
|
## Installing directly on Windows 10 with WSL 2
|
||||||
|
|
||||||
We will be using Microsoft's new feature [WSL
|
Zulip's development environment is most easily setup on Windows using
|
||||||
2](https://docs.microsoft.com/en-us/windows/wsl/wsl2-about) for
|
the [WSL 2](https://docs.microsoft.com/en-us/windows/wsl/wsl2-about)
|
||||||
installation.
|
installation method described here.
|
||||||
|
|
||||||
WSL 2 can be uninstalled by following the instructions [here from Microsoft](https://docs.microsoft.com/en-us/windows/wsl/faq#how-do-i-uninstall-a-wsl-distribution-).
|
|
||||||
|
|
||||||
1. Install WSL 2 by following the instructions provided by Microsoft
|
1. Install WSL 2 by following the instructions provided by Microsoft
|
||||||
[here](https://docs.microsoft.com/en-us/windows/wsl/wsl2-install).
|
[here](https://docs.microsoft.com/en-us/windows/wsl/wsl2-install).
|
||||||
|
|
||||||
1. Install the `Ubuntu 18.04` Linux distribution from the Microsoft
|
1. Install the `Ubuntu 18.04` Linux distribution from the Microsoft
|
||||||
Store.
|
Store.
|
||||||
|
|
||||||
1. Launch the `Ubuntu 18.04` shell and run the following commands:
|
1. Launch the `Ubuntu 18.04` shell and run the following commands:
|
||||||
|
|
||||||
|
@ -139,6 +137,10 @@ Store.
|
||||||
environment](../development/setup-vagrant.html#step-4-developing),
|
environment](../development/setup-vagrant.html#step-4-developing),
|
||||||
ignoring the parts about `vagrant` (since you're not using it).
|
ignoring the parts about `vagrant` (since you're not using it).
|
||||||
|
|
||||||
|
WSL 2 can be uninstalled by following [Microsoft's documentation][uninstall-wsl]
|
||||||
|
|
||||||
|
[uninstall-wsl]: https://docs.microsoft.com/en-us/windows/wsl/faq#how-do-i-uninstall-a-wsl-distribution-
|
||||||
|
|
||||||
## Using the Vagrant Hyper-V provider on Windows (beta)
|
## Using the Vagrant Hyper-V provider on Windows (beta)
|
||||||
|
|
||||||
You should have [Vagrant](https://www.vagrantup.com/downloads) and
|
You should have [Vagrant](https://www.vagrantup.com/downloads) and
|
||||||
|
|
|
@ -156,7 +156,7 @@ Debian](https://docs.docker.com/install/linux/docker-ce/debian/).
|
||||||
|
|
||||||
```eval_rst
|
```eval_rst
|
||||||
.. note::
|
.. note::
|
||||||
We now recommend using `WSL 2 for Windows development <../development/setup-advanced.html#installing-directly-on-windows-10-experimental>`_.
|
We recommend using `WSL 2 for Windows development <../development/setup-advanced.html#installing-directly-on-windows-10-with-wsl-2>`_.
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Install [Git for Windows][git-bash], which installs *Git BASH*.
|
1. Install [Git for Windows][git-bash], which installs *Git BASH*.
|
||||||
|
|
Loading…
Reference in New Issue