From 553fe91b56ceb8456b0ccea3dd0f7879c1b109a8 Mon Sep 17 00:00:00 2001 From: Jeremy Felt Date: Tue, 3 Jan 2017 22:31:39 -0800 Subject: [PATCH 1/3] Move existing README.md file to new docs/ directory This is the first step toward a new documentation structure that will sync the contents of the docs directory into a versioned system on varyingvagrantvagrants.org. At the same time, this will allow us to pare down the content stored in the repository's README.md file. --- README.md => docs/index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.md => docs/index.md (100%) diff --git a/README.md b/docs/index.md similarity index 100% rename from README.md rename to docs/index.md From 75f3f1ac2f014a2de477c80a51d8827e43a49b5a Mon Sep 17 00:00:00 2001 From: Jeremy Felt Date: Tue, 3 Jan 2017 22:47:25 -0800 Subject: [PATCH 2/3] Re-add pared down version of README from docs/index.md This is more what the README on the GitHub project should look like. There are more tweaks to be made, but this will hopefully provide the right start. --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..ee15b3c8d --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# Varying Vagrant Vagrants + +Varying Vagrant Vagrants is an open source [Vagrant](https://www.vagrantup.com) configuration focused on [WordPress](https://wordpress.org) development. + +* **Version**: 1.4.0 +* **Latest Stable**: [1.4.0](https://github.com/Varying-Vagrant-Vagrants/VVV/releases/tag/1.4.0) +* **Web**: [https://varyingvagrantvagrants.org/](https://varyingvagrantvagrants.org/) +* **Contributing**: Contributions are more than welcome. Please see our current [contributing guidelines](https://github.com/Varying-Vagrant-Vagrants/VVV/blob/master/CONTRIBUTING.md). Thanks! + +VVV is copyright (c) 2014-2017, the contributors of the VVV project under the [MIT License](LICENSE). + +## Project Objectives + +* Provide an approachable development environment with a modern server configuration. +* Continue to work towards a stable state of software and configuration included in the default provisioning. +* Provide excellent and clear documentation throughout VVV to aid in both learning and scaffolding. + +VVV is ideal for developing themes and plugins as well as for [contributing to WordPress core](https://make.wordpress.org/core/). + +### Software included with Varying Vagrant Vagrants + +VVV is built on a Ubuntu 14.04 LTS (Trusty) base VM and provisions the server with current versions of several software packages, including: + +1. [nginx](http://nginx.org/) ([mainline](http://nginx.com/blog/nginx-1-6-1-7-released/) version) +1. [mysql](https://www.mysql.com/) 5.5.x +1. [php-fpm](http://php-fpm.org/) 7.0.x +1. [WP-CLI](http://wp-cli.org/) (master branch) +1. [memcached](http://memcached.org/) +1. [PHPUnit](https://phpunit.de/) +1. [Composer](https://github.com/composer/composer) +1. [NodeJs](https://nodejs.org/) +1. [Mailcatcher](http://mailcatcher.me/) + +For a more comprehensive list, please see the [full documentation](https://varyingvagrantvagrants.org). + +### How to Use Varying Vagrant Vagrants + +Full documentation can be found in the `docs/` directory of this repository and on the [varyingvagrantvagrants.org](https://varyingvagrantvagrants.org) website. + +VVV requires recent versions of both Vagrant and VirtualBox. + +[Vagrant](https://www.vagrantup.com) is a "tool for building and distributing development environments". It works with [virtualization](https://en.wikipedia.org/wiki/X86_virtualization) software such as [VirtualBox](https://www.virtualbox.org/) to provide a virtual machine sandboxed from your local environment. + +Besides VirtualBox, provider support is also included for Parallels, Hyper-V, VMWare Fusion, and VMWare Workstation. + +## Contributors + +The following people have contributed code to the VVV projects. Names are listed in order of initial contribution. + + [@jeremyfelt](https://github.com/jeremyfelt), [@carldanley](https://github.com/carldanley), [@ericmann](https://github.com/ericmann), [@lkwdwrd](https://github.com/lkwdwrd), [@TheLastCicada](https://github.com/TheLastCicada), [@tddewey](https://github.com/tddewey), [@johnpbloch](https://github.com/johnpbloch), [@kadamwhite](https://github.com/kadamwhite), [@scribu](https://github.com/scribu), [@danielbachhuber](https://github.com/danielbachhuber), [@tollmanz](https://github.com/tollmanz), [@mbijon](https://github.com/mbijon), [@markjaquith](https://github.com/markjaquith), [@curtismchale](https://github.com/curtismchale), [@Mamaduka](https://github.com/mamaduka), [@lgedeon](https://github.com/lgedeon), [@pmgarman](https://github.com/pmgarman), [@westonruter](https://github.com/westonruter), [@petemall](https://github.com/petemall), [@cmmarslender](https://github.com/cmmarslender), [@mintindeed](https://github.com/mintindeed), [@mboynes](https://github.com/mboynes), [@aaronjorbin](https://github.com/aaronjorbin), [@tobiasbg](https://github.com/tobiasbg), [@simonwheatley](https://github.com/simonwheatley), [@ocean90](https://github.com/ocean90), [@lvnilesh](https://github.com/lvnilesh), [@alexw23](https://github.com/alexw23), [@zamoose](https://github.com/zamoose), [@leewillis77](https://github.com/leewillis77), [@imichaeli](https://github.com/imichaeli), [@andrezrv](https://github.com/andrezrv), [@cadwell](https://github.com/cadwell), [@cfoellmann](https://github.com/cfoellmann), [@westi](https://github.com/westi), [@ryanduff](https://github.com/ryanduff), [@selinerdominik](https://github.com/selinerdominik), [@ericandrewlewis](https://github.com/ericandrewlewis), [@vDevices](https://github.com/vDevices), [@sunnyratilal](https://github.com/sunnyratilal), [@enejb](https://github.com/enejb), [@salcode](https://github.com/salcode), [@mattbanks](https://github.com/mattbanks), [@aaroncampbell](https://github.com/aaroncampbell), [@tnorthcutt](https://github.com/tnorthcutt), [@neilpie](https://github.com/neilpie), [@francescolaffi](https://github.com/francescolaffi), [@itsananderson](https://github.com/itsananderson), [@foolswis](https://github.com/foolswis), [@lloydde](https://github.com/lloydde), [@jmbarlow](https://github.com/jmbarlow), [@nacin](https://github.com/nacin), [@thewebists](https://github.com/thewebists), [@iparr](https://github.com/iparr), [@chrishepner](https://github.com/chrishepner), [@miya0001](https://github.com/miya0001), [@iamntz](https://github.com/iamntz), [@mirmillo](https://github.com/mirmillo), [@garyjones](https://github.com/garyjones), [@teraphy](https://github.com/teraphy), [@DrewAPicture](https://github.com/DrewAPicture), [@jjeaton](https://github.com/jjeaton), [@ntwb](https://github.com/ntwb), [@bradp](https://github.com/bradp), [@jb510](https://github.com/jb510), [@pbearne](https://github.com/pbearne), [@robneu](https://github.com/robneu), [@hubdotcom](https://github.com/hubdotcom), [@michaelbeil](https://github.com/michaelbeil), [@EHLOVader](https://github.com/EHLOVader), [@HongPong](https://github.com/HongPong), [@twisty7867](https://github.com/twisty7867), [@khromov](https://github.com/khromov), [@amchoukir](https://github.com/amchoukir), [@grantnorwood](https://github.com/grantnorwood), [@MatthewEppelsheimer](https://github.com/MatthewEppelsheimer), [@cristovaov](https://github.com/cristovaov), [@coreymckrill](https://github.com/coreymckrill), [@jonathanbardo](https://github.com/jonathanbardo), [@rasmusbe](https://github.com/rasmusbe), [@eriktrom](https://github.com/eriktrom), [@f4bsch](https://github.com/f4bsch), [@meitar](https://github.com/meitar), [@keegoid](https://github.com/keegoid), [@LoreleiAurora](https://github.com/LoreleiAurora), [@cobyan](https://github.com/cobyan), [@goblindegook](https://github.com/goblindegook), [@dlackty](https://github.com/dlackty), [@rene-hermenau](https://github.com/rene-hermenau), [@jdevalk](https://github.com/jdevalk), [@kadimi](https://github.com/kadimi), [@sc0ttkclark](https://github.com/sc0ttkclark), [@jonathanbossenger](https://github.com/jonathanbossenger), [@hello-jason](https://github.com/hello-jason), [@weskoop](https://github.com/weskoop), [@thebrandonallen](https://github.com/thebrandonallen) From 26331b86648186199ee4246fc79148de759a6a40 Mon Sep 17 00:00:00 2001 From: Jeremy Felt Date: Wed, 4 Jan 2017 09:01:44 -0800 Subject: [PATCH 3/3] Use language specific directories for documentation This is easy now because we only have one file and one language :) --- docs/{ => en-US}/index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{ => en-US}/index.md (100%) diff --git a/docs/index.md b/docs/en-US/index.md similarity index 100% rename from docs/index.md rename to docs/en-US/index.md