VVV 2 Documentation #1112

tomjn · 2017-02-28T18:01:38Z

WIP PR for VVV 2 docs

tomjn · 2017-02-28T18:21:30Z

Should fix #1035 when merged

tomjn · 2017-03-02T18:31:39Z

Current structure is:

Landing page

What is VVV?
Installing
Basic Usage
Default Credentials
Built in WordPress installs
Adding a New Site
	Nginx configs
	Setup script
	Custom domains and hosts
	Migrating from VVV 1
Adding an Existing Site
Changing PHP Versions
vvv-config.yml - a reference

Troubleshooting
The VVV 2 Provisioner
Contributing
History

I'm considering moving the changing PHP versions into adding a new site, does nesting anything else make sense here? I believe every file has something in it now, even if it's unfinished. There are TODO markers in a lot of places

Also, @LoreleiAurora if you can look in the VVV 2 provisioner page and just splurge out random notes of things it needs to mention. I'll edit and rewrite into something nice, that page is intended as a primer for anybody who wants to know how the provisioner works, and what the various files do, as well as any important things they should know and what feature is implemented where. It doesn't need to be anything fancy or understandable as long as I can poke you on Hangouts with "what's this thing?!" it'll be fine :)

tomjn · 2017-03-03T15:32:37Z

I have 2 files to write, the vvv-init.sh page, and the VVV 2 provisioner page, but the rest is in good shape and close to final form.

Most importantly though, it's ready for feedback! I need eyes to look at this and search for grammar, typos, and things I might have missed in my checks. I also need a critical eye cast over the page structure, does it make sense? Do I need to move a page here? A section needs expanding? A subheading that'd be better as a full heading or in another file?

LoreleiAurora · 2017-03-07T16:34:05Z

This also needs documentation for #1121 which allows core VM settings to be set.

LoreleiAurora · 2017-03-07T16:34:47Z

Hoping to read through all of this later today :)

tomjn · 2017-03-07T23:06:57Z

Did a rebase on to develop and some sparse documentation of vm_config

LoreleiAurora · 2017-03-08T20:14:41Z

docs/en-US/index.md

-* **Contributors**: [@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)
-
-* **Contributing**: Contributions are more than welcome. Please see our current [contributing guidelines](https://github.com/Varying-Vagrant-Vagrants/VVV/blob/master/CONTRIBUTING.md). Thanks!
+[How to Contribute](contributing.md)

 ## Table of Content ##
 * [Overview](#overview)


Removed in ed9ae75

LoreleiAurora · 2017-03-08T20:18:12Z

docs/en-US/installation.md

+    1. Install the [vagrant-vbguest](https://github.com/dotless-de/vagrant-vbguest) plugin with `vagrant plugin install vagrant-vbguest`.
+        * Note: This step is not a requirement. When installed, it keeps the [VirtualBox Guest Additions](https://www.virtualbox.org/manual/ch04.html) kernel modules of your guest synchronized with the version of your host whenever you do `vagrant up`. This can prevent some subtle shared folder errors.
+1. Clone or extract the Varying Vagrant Vagrants project into a local directory
+    * `git clone git://github.com/Varying-Vagrant-Vagrants/VVV.git vagrant-local`


We should change this to git clone -b master git://github.com/Varying-Vagrant-Vagrants/VVV.git vagrant-local as per #1072.

Changed in eae4c2d

LoreleiAurora · 2017-03-08T20:21:26Z

docs/en-US/installation.md

+1. Suspend the box's state in memory with `vagrant suspend` and bring it right back with `vagrant resume`.
+1. Reapply provisioning to a running box with `vagrant provision`.
+1. Destroy the box with `vagrant destroy`. Files added in the `www` directory will persist on the next `vagrant up`.
+1. Start modifying and adding local files to fit your needs. Take a look at [Auto Site Setup](https://github.com/varying-vagrant-vagrants/vvv/wiki/Auto-site-Setup) for tips on adding new projects.


Shouldn't this direct the user to docs that include the use of the config file?

Fixed and moved to a subfolder

LoreleiAurora · 2017-03-08T20:26:14Z

docs/en-US/adding-a-new-site/custom-domains-hosts.md

+example.net
+```
+
+## vvv-init.sh


This does not update the hosts file on the parent machine. It is just a hacky workaround from before #1080 was merged.

Removed in 790ee7b

LoreleiAurora · 2017-03-08T20:33:55Z

docs/en-US/adding-a-new-site/nginx-configs.md

+
+The `{upstream}` variable is set from `vvv-custom.yml`, and is used to determine the version of PHP to use. Removing this will disable that functionality.
+
+It may be desirable to force a site to use a particular version of PHP, for details see the [changing PHP versions])(../changing-php-version.md) documentation.


Broken link.

I'm not sure how links are meant to reference each other, ../ was a best guess

Fixed in 5fc99e7

LoreleiAurora · 2017-03-08T20:36:29Z

docs/en-US/adding-a-new-site.md

+  repo: https://github.com/example/example.git
+  hosts:
+  - example.local
+```


Should probably include or link to docs on the 3 provisioning files, and possibly https://github.com/Varying-Vagrant-Vagrants/custom-site-template

Should this be merged with adding-an existing-site.md

Adding an existing site could replace the main index file of adding a new site

LoreleiAurora · 2017-03-08T20:41:15Z

docs/en-US/basic-usage.md

+
+## Reloading `vvv-custom.yml`
+
+If you make any changes to your config file, they won't take immediate effect. For changes to take hold, restart VVV using `vagrant reload`


vagrant reload --provision

Fixed in 1ce00fe

LoreleiAurora · 2017-03-08T20:44:22Z

docs/en-US/changing-php-version.md

+ set $upstream php71;
+```
+
+That site is now using PHP 7.1. It may still be necessary though to add the version of PHP to the `utilities` section of `vvv-custom.yml`


It may still be necessary though to add the version of PHP to the utilities section of vvv-custom.yml

Totally unnecessary

Fixed in e08b136

LoreleiAurora · 2017-03-08T22:04:35Z

docs/en-US/what-is-vvv.md

+1. [WordPress Stable](https://wordpress.org/)
+1. [WP-CLI](http://wp-cli.org/) (master branch)
+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


MariaDB 10.1

Fixed in d98cc1a

jeremyfelt · 2017-03-10T05:45:58Z

@tomjn @LoreleiAurora I'd be okay to merge this as soon as the branch is up to date. It may be easier then to process any other docs changes over the next several days through smaller PRs.

Great work so far!

…ection

…hat doesn't do everything I thought it did

… site setup, and point index.md to the new install location

…adding a new site page

…her pages in adding a new site

LoreleiAurora · 2017-03-11T00:19:30Z

Rebased onto develop

jeremyfelt modified the milestone: 2.0.0 Mar 4, 2017

jeremyfelt mentioned this pull request Mar 4, 2017

local.wordpress-trunk.dev Removed #1096

Closed

LoreleiAurora suggested changes Mar 8, 2017

View reviewed changes

jeremyfelt mentioned this pull request Mar 10, 2017

general suggestions to improve your "read me" file. #695

Closed

jeremyfelt mentioned this pull request Mar 10, 2017

[wip] Document the new provisioning system. Varying-Vagrant-Vagrants/varyingvagrantvagrants.org#7

Closed

tomjn added 17 commits March 11, 2017 00:16

creates doc files and moves stuff out of index.md

897e978

documents changing the version of PHP a site uses

44b793f

documents migrating a site from VVV1 to the new provisioner

2a6c058

start the custom domains and hosts doc and some subheadings wip

716dba6

explain the difference between vm_dir and local_dir

242e221

add a basic new site doc

26110be

move the nonstandard folders docs into a new page

8102beb

switch from my personal username to a generic one

c224002

adds some minimal documentation demonstrating a full vvv-config.yml

322f873

swap the json to yaml

2226f7f

make a mention of the database backup system in the troubleshooting s…

dde629c

…ection

adjust installation instructions

612df43

move some stuff out of index.md into the sub pages

d657ca9

expand the nginx configs page and add todo markers and headings

c83c4ea

super high level placeholder notes for the provisioner page

7eb4b06

move the now what section to the installation page

2e494cb

placeholder text for setup script page

6ad8380

tomjn and others added 24 commits March 11, 2017 00:17

adds a missing parameter to a vagrant reload instruction

5da9671

remove a section on adding hosts via vvv-init.sh, seems it's a hack t…

8ddfb90

…hat doesn't do everything I thought it did

adjust the git clone command to use the master branch

869a50d

a little cleanup of the index file and some dead links removed

5f7a49d

moved the adding a new site file to the subfolder as index.md

30135cf

rehash index.md some more and link to pages

043905f

Fix broken link

262b28f

moves the installation page into the installation subfolder

7eb2663

adjust the install page to reference the docs instead of the wiki for…

44ecbbc

… site setup, and point index.md to the new install location

add a paragraph to the setup script page

6a3bdf7

remove second history section from the main file

d1cd67b

tell github the codeblocks are YAML

e8ad13c

specifies the language in each code block and adds --provision in palces

298cab9

remove the add an existing site page and merge its contents into the …

5e1bffe

…adding a new site page

remove references to the removed page

39bc14a

moves some content to the setup script page, and adds links to the ot…

65cdddc

…her pages in adding a new site

moves the changing PHP version page into the adding a new site subfolder

5cbaad1

change the links to the PHP changing page

d1b2171

removes the vvv 2 provisioner page, to be readded when its written

325b583

mentions the utilities and vm_config sections in the vvv config page

739062c

remove a stray word

a92531e

remove reference to the provisioner doc that was remvoed

123163a

Fix spacing in code blocks

9d1a911

symlink contributing.md to contributing.md in docs

89f05a8

LoreleiAurora force-pushed the v2_docs branch from 42ccdb3 to 89f05a8 Compare March 11, 2017 00:18

Fix spacing in list

2007cb4

LoreleiAurora approved these changes Mar 11, 2017

View reviewed changes

LoreleiAurora merged commit a1a5234 into Varying-Vagrant-Vagrants:develop Mar 11, 2017

LoreleiAurora mentioned this pull request Mar 11, 2017

Document the new provisioning system #1035

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VVV 2 Documentation #1112

VVV 2 Documentation #1112

tomjn commented Feb 28, 2017

tomjn commented Feb 28, 2017

tomjn commented Mar 2, 2017

tomjn commented Mar 3, 2017

LoreleiAurora commented Mar 7, 2017

LoreleiAurora commented Mar 7, 2017

tomjn commented Mar 7, 2017

LoreleiAurora Mar 8, 2017

tomjn Mar 10, 2017

LoreleiAurora Mar 8, 2017

tomjn Mar 10, 2017

LoreleiAurora Mar 8, 2017

tomjn Mar 10, 2017

LoreleiAurora Mar 8, 2017

tomjn Mar 10, 2017

LoreleiAurora Mar 8, 2017

tomjn Mar 10, 2017

LoreleiAurora Mar 10, 2017

LoreleiAurora Mar 8, 2017

LoreleiAurora Mar 8, 2017

tomjn Mar 10, 2017

LoreleiAurora Mar 8, 2017

tomjn Mar 10, 2017

LoreleiAurora Mar 8, 2017

tomjn Mar 10, 2017

LoreleiAurora Mar 8, 2017

tomjn Mar 10, 2017

jeremyfelt commented Mar 10, 2017

LoreleiAurora commented Mar 11, 2017


		The `{upstream}` variable is set from `vvv-custom.yml`, and is used to determine the version of PHP to use. Removing this will disable that functionality.

		It may be desirable to force a site to use a particular version of PHP, for details see the [changing PHP versions])(../changing-php-version.md) documentation.


		## Reloading `vvv-custom.yml`

		If you make any changes to your config file, they won't take immediate effect. For changes to take hold, restart VVV using `vagrant reload`

VVV 2 Documentation #1112

VVV 2 Documentation #1112

Conversation

tomjn commented Feb 28, 2017

tomjn commented Feb 28, 2017

tomjn commented Mar 2, 2017

tomjn commented Mar 3, 2017

LoreleiAurora commented Mar 7, 2017

LoreleiAurora commented Mar 7, 2017

tomjn commented Mar 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeremyfelt commented Mar 10, 2017

LoreleiAurora commented Mar 11, 2017