Installation instructions for Vagrant are too vague?

[josmperez1]

Hi,

Maybe I'm wrong, but it seems to me that the installation instructions for Vagrant are way too vague regarding the file paths.

You're supposed to clone the slate repo, install Vagrant/VirtualBox, and then magically your documentation appears?!

Well, where were you supposed to put your documentation files to begin with? How does Slate magically "know" where your documentation files are so that they can be built?

I've been trying to install Slate for over a week on an important project and I'm getting a bit desperate.

[MasterOdin]

I would agree the docs rely too heavily on the reader knowing what exactly is Vagrant and works.

Well, where were you supposed to put your documentation files to begin with? How does Slate magically "know" where your documentation files are so that they can be built?

When you run vagrant up within the slate directory, a VM gets spun up with all the slate dependencies / runtime, and that mounts your directory as a guest directory to /vagrant within the VM. This is done automatically for you. As such, so long as you've got your documentation in the source/ directory, Slate will work by running cd /vagrant; bundle exec middleman build within the VM, where the first command gets us into our guest directory and the second assumes it's running within the root of your directory with your files in source/ (/vagrant/source) and will generate the output to build/ (/vagrant/build).