diff --git a/_config.yml b/_config.yml index 4c414a07..6a3f3818 100644 --- a/_config.yml +++ b/_config.yml @@ -47,4 +47,6 @@ navigation: - text: Documentation url: contrib/docs/ - text: Testing - url: contrib/testing/ \ No newline at end of file + url: contrib/testing/ + - text: Vagrant + url: contrib/vagrant/ diff --git a/contrib/docs.md b/contrib/docs.md index e10129ff..c616331b 100644 --- a/contrib/docs.md +++ b/contrib/docs.md @@ -5,39 +5,12 @@ layout: contrib ### Running docs locally - -If you're running these docs on your local machine; +To build the docs, run [jekyll](http://jekyllrb.com/): ``` jekyll serve ``` -### Running docs on Vagrant +If you rather use Vagrant, see [these instructions][v]. -This requires several libraries, and you can keep these self contained by using [Vagrant](https://www.vagrantup.com/). - -``` -vagrant init ubuntu/trusty64 -vagrant up -vagrant ssh -- "sudo apt-get -y install ruby-dev nodejs" -vagrant ssh -- "sudo gem install jekyll" -vagrant ssh -- "(cd /vagrant; jekyll serve)" -``` - -You'll also need to add a port forward entry to your `Vagrantfile`; - -``` -config.vm.network "forwarded_port", guest: 4000, host: 4001 -``` - -Then you can access the docs using; - -``` -http://127.0.0.1:4001 -``` - -You also may need to forcibly kill Jekyll if you ctrl+c; - -``` -vagrant ssh -- "sudo killall -9 jekyll" -``` \ No newline at end of file +[v]: {{site.baseurl}}docs/contrib/vagrant/ diff --git a/contrib/testing.md b/contrib/testing.md index f0441055..a2d784f5 100644 --- a/contrib/testing.md +++ b/contrib/testing.md @@ -11,16 +11,6 @@ To run tests locally; tox ``` -### Testing RQ with Vagrant +If you rather use Vagrant, see [these instructions][v]. -This requires several libraries, and you can keep these self contained by using [Vagrant](https://www.vagrantup.com/). - -To create a working vagrant environment, use the following; - -``` -vagrant init ubuntu/trusty64 -vagrant up -vagrant ssh -- "sudo apt-get -y install redis-server python-dev python-pip" -vagrant ssh -- "sudo pip install --no-input redis hiredis mock" -vagrant ssh -- "(cd /vagrant; ./run_tests)" -``` +[v]: {{site.baseurl}}docs/contrib/vagrant/ diff --git a/contrib/vagrant.md b/contrib/vagrant.md new file mode 100644 index 00000000..c114c7ca --- /dev/null +++ b/contrib/vagrant.md @@ -0,0 +1,50 @@ +--- +title: "Using Vagrant" +layout: contrib +--- + +If you don't feel like installing dependencies on your main development +machine, you can use [Vagrant](https://www.vagrantup.com/). Here's how you run +your tests and build the documentation on Vagrant. + + +### Running tests in Vagrant + +To create a working Vagrant environment, use the following; + +``` +vagrant init ubuntu/trusty64 +vagrant up +vagrant ssh -- "sudo apt-get -y install redis-server python-dev python-pip" +vagrant ssh -- "sudo pip install --no-input redis hiredis mock" +vagrant ssh -- "(cd /vagrant; ./run_tests)" +``` + + +### Running docs on Vagrant + +``` +vagrant init ubuntu/trusty64 +vagrant up +vagrant ssh -- "sudo apt-get -y install ruby-dev nodejs" +vagrant ssh -- "sudo gem install jekyll" +vagrant ssh -- "(cd /vagrant; jekyll serve)" +``` + +You'll also need to add a port forward entry to your `Vagrantfile`; + +``` +config.vm.network "forwarded_port", guest: 4000, host: 4001 +``` + +Then you can access the docs using; + +``` +http://127.0.0.1:4001 +``` + +You also may need to forcibly kill Jekyll if you ctrl+c; + +``` +vagrant ssh -- "sudo killall -9 jekyll" +```