Added more explanation to developing with Vagrant

diff --git a/doc/Github.md b/doc/Github.md
index a59f574cfbd4e10fbfc235f80f77d32b03defb8f..efee32d5baa9b3a4c2842cebeefdc56320f1559f 100644 (file)
--- a/doc/Github.md
+++ b/doc/Github.md
@@ -24,13 +24,5 @@ Please pull in any changes from the project repository and merge them with your
 
 Also - **test your changes**. Don't assume that a simple fix won't break something else. If possible get an experienced Friendica developer to review the code. 
 
-**Vagrant**
-
-[Vagrant](https://www.vagrantup.com/) is a virtualization solution for developers. No need to setup up a webserver etc. before actually starting. Vagrant creates a virtual machine (an Ubuntu 12.04) for you that you can just run inside VirtualBox and start to work directly on Friendica. What you need to do:
-
-1. Install VirtualBox and vagrant.
-2. git clone Friendica (note the Vagrantfile inside).
-3. Run vagrant up, have some patience.
-4. Run vagrant ssh to log into the virtual machine.
-5. It depends on the network setup of your host and virtual box guest how you reach the friendica web interface of the VM.
+Check out how to work with [our Vagrant](help/Vagrant) to save a lot of setup time!
 

diff --git a/doc/Home.md b/doc/Home.md
index 62fd216659ce8195f930e42ab13a7e7e048c944e..031bec8058a8af3a6e803ba6fa7fc9961bc028e5 100644 (file)
--- a/doc/Home.md
+++ b/doc/Home.md
@@ -37,6 +37,7 @@ Friendica Documentation and Resources
 
 * [Where to get started?](help/Developers-Intro)
 * [Help on Github](help/Github)
+* [Help on Vagrant](help/Vagrant)
 * [How to translate Friendica](help/translations)
 * [Bugs and Issues](help/Bugs-and-Issues)
 

diff --git a/doc/Vagrant.md b/doc/Vagrant.md
new file mode 100644 (file)
index 0000000..dec8112
--- /dev/null
+++ b/doc/Vagrant.md
@@ -0,0 +1,15 @@
+Vagrant for Friendica Developers
+===================
+
+* [Home](help)
+
+[Vagrant](https://www.vagrantup.com/) is a virtualization solution for developers. No need to setup up a webserver, database etc. before actually starting. Vagrant creates a virtual machine (an Ubuntu 12.04) for you that you can just run inside VirtualBox and start to work directly on Friendica. What you need to do:
+
+1. Install VirtualBox and vagrant.
+2. Git clone your Friendica repository. Inside, you'll find a "Vagrantfile" and some scripts in the utils folder.
+3. Run "vagrant up" from inside the friendica clone. Be patient: When it runs for the first time, it downloads an Ubuntu Server image.
+4. Run "vagrant ssh" to log into the virtual machine to log in to the VM.
+5. Open 192.168.22.10 in a browser to finish the Friendica installation. The mysql database is called "friendica", the mysql user and password both are "root".
+6. Work on Friendica's code in your git clone on your machine (not in the VM).
+7. Check the changes in your browser in the VM. Debug via the "vagrant ssh" login.
+8. Commit and push your changes directly back to Github.