[PR] Create an initial documentation structure, refactor README #1073
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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.
grappler
reviewed
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) |
There was a problem hiding this comment.
What about just linking to contributor page? https://github.com/Varying-Vagrant-Vagrants/VVV/graphs/contributors
There was a problem hiding this comment.
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. :)
|
To make translations easier later i thing the structure should be more like |
This is easy now because we only have one file and one language :)
I spaced on this. Updated! :) |
LoreleiAurora
approved these changes
Jan 4, 2017
jeremyfelt
changed the title
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR will probably require some manual merging as we'll be re-generating the 1.4.0 tag on the
masterbranch to include it and it will be merged into thedevelopbranch.A few things are involved here:
docs/index.mdfile that contains the 1.4.0 version of VVV'sREADME.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.README.mdfile 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.