Repository: cordova-docs Updated Branches: refs/heads/master 3161569ff -> f951562da
Add a bit more explanation about vagrant. Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/f951562d Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/f951562d Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/f951562d Branch: refs/heads/master Commit: f951562da372ea2d2806ca1c31e836b7ef7b0778 Parents: 3161569 Author: Marcel Kinard <[email protected]> Authored: Tue Jun 10 08:35:26 2014 -0400 Committer: Marcel Kinard <[email protected]> Committed: Tue Jun 10 08:35:26 2014 -0400 ---------------------------------------------------------------------- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f951562d/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 5e65910..e935092 100644 --- a/README.md +++ b/README.md @@ -75,10 +75,21 @@ Each language can override the default template in `template/docs/LANGUAGE`. ### Editorial Guidelines -Please see the `STYLESHEET.md` file for guildelines on language and usage. +Please see the `STYLESHEET.md` file for guidelines on language and usage. ## Generating Documentation with Vagrant +It can be trouble generating the documentation. Juggling Ruby +environments and the dependencies can be a sensitive matter. + +To make our lives easier, Vagrant support has been added to our documentation +generator. It's easy to setup and works on all the major operating +systems. After you've installed Vagrant and VirtualBox, you only need to +run one command to download and provision a light-weight virtual machine +(approx 200MB). At that point all the dependencies exist inside the +virtual machine, so you don't need to install them manually on your +bare metal machine. + ### Setup - [Install Vagrant](http://www.vagrantup.com/downloads.html) @@ -105,9 +116,11 @@ both your virtual and local machine. ### Shutdown the Virtual Machine +Pick one of the following, depending on what you want to do: + $ vagrant suspend # pause the vm and save its state $ vagrant halt # shutdown the vm - $ vagrant destroy # delete the vm + $ vagrant destroy # delete the vm and all its contents ## Generating Documentation Locally
