[PR] Create an initial documentation structure, refactor README #1073

Merged
merged 3 commits into from Jan 16, 2017

Projects

None yet

3 participants

@jeremyfelt
Member

This PR will probably require some manual merging as we'll be re-generating the 1.4.0 tag on the master branch to include it and it will be merged into the develop branch.

A few things are involved here:

  • A new docs/index.md file that contains the 1.4.0 version of VVV's README.md. This will allow us to generate a base version of the documentation at varyingvagrantvagrants.org before the new provisioner changes in the upcoming 2.0.0. This file has been moved from the old README.md so that git history is maintained.
  • A stripped down README.md file to provide some more clear basics on the GitHub repository for new visitors and contributors.

Everything is up for discussion here, but this should get us moving toward the right answer.

See #963, #1049.

jeremyfelt added some commits Jan 4, 2017
@jeremyfelt jeremyfelt 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.
553fe91
@jeremyfelt jeremyfelt 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.
75f3f1a
@jeremyfelt jeremyfelt added this to the 2.0.0 milestone Jan 4, 2017
@jeremyfelt jeremyfelt requested a review from LoreleiAurora Jan 4, 2017
-In January of 2014, [10up](http://10up.com) made the decision to [spin VVV off](http://10up.com/blog/varying-vagrant-vagrants-future/) into its own organization to better align with the community that has grown around the project over time. This transition opens doors for what [Varying Vagrant Vagrants, the organization](https://jeremyfelt.com/code/2014/01/27/varying-vagrant-vagrants-organization/) can accomplish as an ongoing project.
+ [@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)
@jeremyfelt
jeremyfelt Jan 4, 2017 Member

Good point, @grappler. That's probably the right answer. I've stuck with this format for so long because I kind of had fun watching the list grow. But we've had a lot of contributors now, so it may be time to change. It would definitely shorten the README. :)

@LoreleiAurora
Member

To make translations easier later i thing the structure should be more like docs/en-US

@jeremyfelt jeremyfelt Use language specific directories for documentation
This is easy now because we only have one file and one language :)
26331b8
@jeremyfelt
Member

To make translations easier later i thing the structure should be more like docs/en-US

I spaced on this. Updated! :)

@jeremyfelt jeremyfelt changed the title from [WIP] [PR] Create an initial documentation structure, refactor README to [PR] Create an initial documentation structure, refactor README Jan 16, 2017
@jeremyfelt jeremyfelt merged commit b73e5a3 into master Jan 16, 2017
@jeremyfelt jeremyfelt deleted the docs/new-structure branch Jan 16, 2017
@jeremyfelt jeremyfelt referenced this pull request Jan 16, 2017
Closed

Refactor the README #963

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment