Move Vagrant info into doc/vagrant.md

README.md

@@ -98,10 +98,10 @@ since it is much faster than a virtualized one. Due to heavy IO operations a
 virtualized installation will be much slower running the app and the tests.
 If you want to use [Vagrant] instead (e.g. need to do development from Windows),
-see [the instructions for our (experimental) Vagrant with Virtualbox setup](#vagrant-with-virtualbox).
+see [the instructions for our (experimental) Vagrant with Virtualbox setup](doc/vagrant.md#vagrant-with-virtualbox).
 If you want to use [Vagrant] with [Docker][docker engine] on Linux,
-see [the instructions for our (experimental) Vagrant with Docker setup](#vagrant-with-docker).
+see [the instructions for our (experimental) Vagrant with Docker setup](doc/vagrant.md#vagrant-with-docker).
 ### Clone GitLab Development Kit repository
@@ -235,84 +235,6 @@ You may need to install Redis 2.8 or newer manually.
 If you got GDK running an another platform please send a merge request to add
 it here.
-### Vagrant setup
-
-[Vagrant] is a tool for setting up identical development environments including
-all dependencies regardless of the host platform you are using. Vagrant will
-default to using [VirtualBox], but it has many plugins for different environments.
-
-Vagrant allows you to develop GitLab without affecting your host machine (but we
-recommend developing GitLab on metal if you can).
-
-#### Vagrant with Virtualbox
-
-Vagrant can be very slow since the files are synced between the host OS and GitLab
-(testing) accesses a lot of files.
-You can improve the speed by keeping all the files on the guest OS but in that
-case you should take care to not lose the files if you destroy or update the VM.
-To avoid usage of slow VirtualBox shared folders we use NFS here.
-
-1. (optional for Windows users) [Disable Hyper-V](http://superuser.com/a/642027/143551)
-   then enable virtualization technology via the BIOS.
-1. Install [VirtualBox] and [Vagrant].
-1. [Configure NFS for Vagrant](http://docs.vagrantup.com/v2/synced-folders/nfs.html)
-   if you are on Linux.
-1. Run `vagrant up --provider=virtualbox` in this directory (from an elevated
-   command prompt if on Windows). Vagrant will download an OS image, bring it
-   up, and install all the prerequisites.
-1. Run `vagrant ssh` to SSH into the box.
-1. Continue setup at [Installation](#installation) below.
-1. After the installation is done, edit the 'gitlab-workhorse' line in
-   your Procfile and change `localhost:3000` to `0.0.0.0:3000`.
-
-#### Vagrant with Docker
-
-[Docker](https://www.docker.com/) is one of possible providers of Vagrant.
-Docker provider has a big advantage, as it doesn't have a big virtualisation
-overhead compared to Virtualbox and provides the native performance via
-containers technology. This Docker setup makes sense only on Linux, as on other
-OSes like Windows/OSX you will have to run the entire Docker hypervisor in a VM
-(which will be almost the same like Vagrant Virtualbox provider).
-
-1. Install [Vagrant](http://www.vagrantup.com).
-1. Install [Docker Engine]. Don't forget to add your user to the docker group
-   and re-login.
-1. Run `vagrant up --provider=docker` in this directory. Vagrant will build a
-   docker image and start the container.
-1. Run `vagrant ssh` to SSH into the container.
-1. Continue setup at [Installation](#installation) below.
-1. After the installation is done, edit the 'gitlab-workhorse' line in
-   your Procfile and change `localhost:3000` to `0.0.0.0:3000`.
-
-#### Vagrant development details
-
-- Open the development environment by running `vagrant up` & `vagrant ssh`
-  (from an elevated command prompt if on Windows).
-- When using Docker, vagrant can ask you about password. The default password
-  is `tcuser`.
-- Follow the general [development guidelines](#development) but running the
-  commands in the `vagrant ssh` session.
-- Files in the `gitlab` and `gitlab-shell` folders will be synced between the
-  host OS & guest OS so can be edited on either the host (under this folder) or
-  guest OS (under `~/gitlab-development-kit/`).
-- When you want to shutdown Vagrant run `exit` from the guest OS and then
-  `vagrant halt` from the host OS.
-
-#### Vagrant troubleshooting
-
-- On some setups the shared folder will have the wrong user. This is detected
-  by the Vagrantfile and you should `sudo su - build` to switch to the correct
-  user in that case.
-- If you get a "Timed out while waiting for the machine to boot" message, you
-  likely forgot to [disable Hyper-V](http://superuser.com/a/642027/143551) or
-  enable virtualization technology via the BIOS.
-- If you have continuous problems starting Vagrant, you can uncomment
-  `vb.gui = true` to view any error messages.
-- If you have problems running `support/edit-gitlab.yml` (bash script despite
-  file extension), see http://stackoverflow.com/a/5514351/1233435.
-- If you have errors with symlinks or Ruby during initialization, make sure you
-  ran `vagrant up` from an elevated command prompt (Windows users).
-
 ## Installation
 The `Makefile` will clone the repositories, install the Gem bundles and set up

doc/vagrant.md

+# GitLab development with Vagrant
+
+In this file we explain different methods of setting up a Vagrant
+virtual machine to do GitLab development in. Please see the [main
+README](../README.md#installation) how to install GDK after you have
+set up your Vagrant machine.
+
+### Vagrant setup
+
+[Vagrant] is a tool for setting up identical development environments including
+all dependencies regardless of the host platform you are using. Vagrant will
+default to using [VirtualBox], but it has many plugins for different environments.
+
+Vagrant allows you to develop GitLab without affecting your host machine (but we
+recommend developing GitLab on metal if you can).
+
+#### Vagrant with Virtualbox
+
+Vagrant can be very slow since the files are synced between the host OS and GitLab
+(testing) accesses a lot of files.
+You can improve the speed by keeping all the files on the guest OS but in that
+case you should take care to not lose the files if you destroy or update the VM.
+To avoid usage of slow VirtualBox shared folders we use NFS here.
+
+1. (optional for Windows users) [Disable Hyper-V](http://superuser.com/a/642027/143551)
+   then enable virtualization technology via the BIOS.
+1. Install [VirtualBox] and [Vagrant].
+1. [Configure NFS for Vagrant](http://docs.vagrantup.com/v2/synced-folders/nfs.html)
+   if you are on Linux.
+1. Run `vagrant up --provider=virtualbox` in this directory (from an elevated
+   command prompt if on Windows). Vagrant will download an OS image, bring it
+   up, and install all the prerequisites.
+1. Run `vagrant ssh` to SSH into the box.
+1. Continue setup at [Installation](#installation) below.
+1. After the installation is done, edit the 'gitlab-workhorse' line in
+   your Procfile and change `localhost:3000` to `0.0.0.0:3000`.
+
+#### Vagrant with Docker
+
+[Docker](https://www.docker.com/) is one of possible providers of Vagrant.
+Docker provider has a big advantage, as it doesn't have a big virtualisation
+overhead compared to Virtualbox and provides the native performance via
+containers technology. This Docker setup makes sense only on Linux, as on other
+OSes like Windows/OSX you will have to run the entire Docker hypervisor in a VM
+(which will be almost the same like Vagrant Virtualbox provider).
+
+1. Install [Vagrant](http://www.vagrantup.com).
+1. Install [Docker Engine]. Don't forget to add your user to the docker group
+   and re-login.
+1. Run `vagrant up --provider=docker` in this directory. Vagrant will build a
+   docker image and start the container.
+1. Run `vagrant ssh` to SSH into the container.
+1. Continue setup at [Installation](#installation) below.
+1. After the installation is done, edit the 'gitlab-workhorse' line in
+   your Procfile and change `localhost:3000` to `0.0.0.0:3000`.
+
+#### Vagrant development details
+
+- Open the development environment by running `vagrant up` & `vagrant ssh`
+  (from an elevated command prompt if on Windows).
+- When using Docker, vagrant can ask you about password. The default password
+  is `tcuser`.
+- Follow the general [development guidelines](#development) but running the
+  commands in the `vagrant ssh` session.
+- Files in the `gitlab` and `gitlab-shell` folders will be synced between the
+  host OS & guest OS so can be edited on either the host (under this folder) or
+  guest OS (under `~/gitlab-development-kit/`).
+- When you want to shutdown Vagrant run `exit` from the guest OS and then
+  `vagrant halt` from the host OS.
+
+#### Vagrant troubleshooting
+
+- On some setups the shared folder will have the wrong user. This is detected
+  by the Vagrantfile and you should `sudo su - build` to switch to the correct
+  user in that case.
+- If you get a "Timed out while waiting for the machine to boot" message, you
+  likely forgot to [disable Hyper-V](http://superuser.com/a/642027/143551) or
+  enable virtualization technology via the BIOS.
+- If you have continuous problems starting Vagrant, you can uncomment
+  `vb.gui = true` to view any error messages.
+- If you have problems running `support/edit-gitlab.yml` (bash script despite
+  file extension), see http://stackoverflow.com/a/5514351/1233435.
+- If you have errors with symlinks or Ruby during initialization, make sure you
+  ran `vagrant up` from an elevated command prompt (Windows users).