VVV Documentation

An open source Vagrant configuration for developing with WordPress

4,526 stars Shell Shell 1 file ยท ~1,020 tokens #vagrant#varying-vagrant-vagrants#vvv#wordpress
RAW Doc

1. Project Overview & Quickstart (Varying-Vagrant-Vagrants/VVV)

VVV

VVV is a local developer environment, mainly aimed at WordPress developers. It uses Vagrant and Docker/VirtualBox/Parallels/HyperV to create a linux server environment for building sites, and contributing to WordPress itself.

VVV stands for Varying Vagrant Vagrants.

How To Use

To use it, download and install Vagrant and a provider such as VirtualBox, Docker, or Parallels Pro. Then, clone this repository and run:

shell
vagrant plugin install --local
vagrant up --provision

This will create a VM capable of hosting sites.

When it's done, visit http://vvv.test to see the default sites, or add a new site via config/config.yml and it will create a new site under the www subfolder.

The online documentation contains more detailed installation instructions.

Minimum System requirements

For system requirements, please read the system requirements documentation here

Software included

For a comprehensive list, please see the list of installed packages.

2. Official Technical Reference & Guides (Varying-Vagrant-Vagrants/Varying-Vagrant-Vagrants.github.io)

varyingvagrantvagrants.org

This repository provides the code and content for varyingvagrantvagrants.org, VVV's official website.

The main branch of this repository deploys to production under varyingvagrantvagrants.org. It also pulls the CONTRIBUTING.md and CHANGELOG.md files from the develop branch of VVV.

Pull requests can be opened against this repository for the following:

  • Issues with deployment configuration through Travis CI.
  • Issues with Jekyll configuration.
  • Updates to the varyingvagrantvagrants.org home page.
  • Updates to varyingvagrantvagrants.org blog posts.
  • Updates to VVV documentation.

Once a pull request is merged to master, Travis CI is used to deploy the built site files to an AWS S3 bucket. Nginx is used to direct traffic to the correct branch directory in the bucket.

Issues to discuss changes to the code and documentation should be opened at the main VVV repository.

Testing and Building

Use this command to run a local instance for writing docs:

sh
bundle exec jekyll serve

It will give you a URL to visit in your browser, and rebuilds the docs and stylesheets when files change.

The site is auto-deployed by Travis when the main branch is updated.