MAGEDOC-2675: Update README in 'magento/devdocs'

- removed /vagrant - updated README
magento · Nov 13, 2017 · ecf6e21 · ecf6e21
1 parent 89cbee1
commit ecf6e21
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 204 deletions.
diff --git a/README.md b/README.md
@@ -6,45 +6,45 @@ To contribute, please fork the `develop` branch.
 
 # Building this site
 
-You can build this site locally using Jekyll
+You can build this site locally in the following ways:
+
+- [using installed Jekyll](#build-using-jekyll) (Mac, Linux)
+- [in a Docker container](#build-using-docker) (Mac, Linux)
+- [on a virtual machine using Vagrant](#build-using-vagrant) (Mac, Linux, Windows)
 
-*	Windows users _must_ build the site in a Vagrant container running on Virtual Box as discussed in more detail in the [Vagrant README](vagrant/README.md).
-
-	We use symbolic links (symlinks) in the `guides/v2.1` directory to link to topics that haven't changed since the 2.0.x release. Because symlinks aren't supported by Windows, you _cannot_ use the Windows environment; you must use a Linux environment.
-
-*	Mac and Linux users can build this site locally using Jekyll or you can use Vagrant. 
-
-	Vagrant might be easier because the software runs in a container that isn't dependent on, and cannot conflict with, any other software installed on your computer.
-
-## Build using Vagrant
-
-To build the site locally using Vagrant you need only the files in the `vagrant/` directory.
-For more information, see the [Vagrant README](vagrant/README.md).
-
-## Requirements
+## <a name="build-using-jekyll"> Build using Jekyll
 
 Currently, building this site requires:
 
-*	Ruby Version: >= 2.0.0
-
-Use [bundler](http://bundler.io/) to get compatible versions of other dependencies.
+*	[Ruby v.2.4.x+](https://www.ruby-lang.org)
+*   [bundler v.1.16.x+](http://bundler.io/)
 
-## Build locally in Mac or Linux
-
-To build this site locally:
+To build this site locally, clone this repository and run in the _devdocs_ directory:
 
 ```bash
 # Install dependencies
 $ bundle install
 
-# Visit http://localhost:4000 in your favorite browser!
+# Run Jekyll server to generate local website
 $ bin/jekyll serve --incremental
 ```
 
+Visit http://localhost:4000 in your favorite browser!
+
+## <a name="build-using-docker"> Build using Docker
+
+[This Docker container](https://github.com/jcalcaben/docker-for-devdocs) contains everything necessary to run Jekyll3 for working with Magento DevDocs.
+
+## <a name="build-using-vagrant"> Build using Vagrant
+
+You can deploy the devdocs site locally using [this Vagrant project](https://github.com/dshevtsov/magento-devdocs-vagrant).
+
+***
+
 If you have questions, open an issue and ask us. We're looking forward to hearing from you!
 
 *	<a href="https://twitter.com/MagentoDevDocs" class="twitter-follow-button" data-show-count="false">Follow @MagentoDevDocs</a>
 
 *	<a href="mailto:DL-Magento-Doc-Feedback@magento.com">E-mail us</a>
 
-*	<a href="http://devdocs.magento.com">Visit our documentation site</a>, built on GitHub using [Jekyll](http://jekyllrb.com/).
+*	<a href="http://devdocs.magento.com">Visit our documentation site</a>, built using [GitHub pages](https://pages.github.com/).
diff --git a/vagrant/README.md b/vagrant/README.md
diff --git a/vagrant/Vagrantfile b/vagrant/Vagrantfile
diff --git a/vagrant/bootstrap.sh b/vagrant/bootstrap.sh