Mention experimental providers in README

Removed outdated information on roles (deferring to `vagrant roles -h`).

Added YARD options in preparation for generation and publishing of docs
via CI.

Change-Id: I47b5f35372c539fdede57e4f4005b5cbcce4eab6

Author: marxarelli

.gitignore

@@ -3,6 +3,7 @@
 /.gem
 /.rbenv-version
 /.settings.yaml
+/.yardoc/
 /*.gem
 /*.sublime-workspace
 /no-update
@@ -32,3 +33,4 @@
 /phab
 /node_modules
 /tmp
+/doc/

.yardopts

@@ -0,0 +1,5 @@
+--readme README.md
+--charset utf-8
+--title "MediaWiki Vagrant"
+--markup markdown
+'lib/**/*.rb' - '*.md' 'support/**/*.md'

Gemfile.lock

@@ -158,6 +158,7 @@ GEM
       rubyntlm (~> 0.1.1)
       savon (= 0.9.5)
       uuidtools (~> 2.1.2)
+    yard (0.8.7.6)
 
 PLATFORMS
   ruby
@@ -170,3 +171,4 @@ DEPENDENCIES
   rspec (~> 3.1, >= 3.1.0)
   rubocop
   vagrant!
+  yard (~> 0.8, >= 0.8.7.6)

README.md

@@ -13,11 +13,14 @@ inspecting and interacting with MediaWiki code, including a powerful debugger
 and an interactive interpreter. Best of all, because the configuration is
 automated and contained in a virtual environment, mistakes are easy to undo.
 
-
 ## Install
 
 You'll need to install recent versions of Vagrant and VirtualBox.
 
+(Note that *experimental* support for Parallels, LXC, VMWare Fusion, and
+Microsoft Hyper-V providers exists. See `support/README-lxc.md` or
+`support/README-parallels.md` for details on the former two.)
+
  * VirtualBox: https://www.virtualbox.org/wiki/Downloads
  * Vagrant: http://www.vagrantup.com/downloads-archive.html (the version must be
    1.4.0 or higher). For NFS, use 1.5.4 or higher.
@@ -95,12 +98,8 @@ The latter will restart the VM.
 
 You can add roles to MediaWiki-Vagrant! A 'role' represents a set of software
 configurations required for giving this machine some special function. Vagrant
-has several commands to manage enabled roles:
-
- * disable-role
- * enable-role
- * list-roles
- * reset-roles
+has several commands to manage enabled roles. See `vagrant roles -h` for more
+help on usage.
 
 If you'd like to use the Vagrant-Mediawiki codebase to describe a development
 environment that you could then share with other developers, you should do so

mediawiki-vagrant.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |s|
 
     s.add_development_dependency 'cucumber', '~> 2.0.0.rc4'
     s.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
+    s.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7.6'
 end