From 226ebe9642a1edfcb0b214fb2dc049ddac6d4cb6 Mon Sep 17 00:00:00 2001
From: stephane <stephane@alum.mit.edu>
Date: Thu, 10 Sep 2015 16:07:15 -0700
Subject: [PATCH] Cleanups for README.vagrant

Assorted cleanups for this readme, including:
- Move file to .rst extension
- Fix bulleted lists
- Mark up literals
- Fix typos

Change-Id: I66f8454c671b3d8d8f126304875285e2599f7dde
---
 README.vagrant         | 36 -------------------------------
 README.vagrant.rst     | 48 ++++++++++++++++++++++++++++++++++++++++++
 doc/source/Vagrant.rst |  1 -
 doc/source/index.rst   |  2 +-
 doc/source/vagrant.rst |  1 +
 5 files changed, 50 insertions(+), 38 deletions(-)
 delete mode 100644 README.vagrant
 create mode 100644 README.vagrant.rst
 delete mode 100644 doc/source/Vagrant.rst
 create mode 100644 doc/source/vagrant.rst

diff --git a/README.vagrant b/README.vagrant
deleted file mode 100644
index 0dc556c36..000000000
--- a/README.vagrant
+++ /dev/null
@@ -1,36 +0,0 @@
-Vagrant support for developers
-==============================
-Bifrost vagrant file for developers can be found in the tools/vagrant_dev_env
-directory. Running 'vagrant up' from with in this folder will bring up an Ubuntu
-Trusty box with bifrost installed.
-
-By default the vm will have three interfaces:
-    eth0 - connected to a NAT network
-    eth1 - connected to Host-only network named: vboxnet1
-    eth2 - bridged - adapter must be set in Vagrantfile
-
-
-Walkthrough done on OS X:
--------------------------
-Setup vagrant by:
-    Installing git
-    Installing virtualbox
-    Installing vagrant
-    Installing ansible
-
-Configure Vagrant with the correct box:
-    vagrant box add ubuntu/trusty64
-
-Clone bifrost repo:
-    git clone https://github.com/openstack/bifrost.git
-
-change in to the bifrost directory
-    cd bifrost/tools/vagrant_dev_env
-
-edit Vagrantfile:
-    change public_key to correct key name
-    change network_interface to match your needs
-    change bridged adaptor
-
-Boot the vm with:
-    vagrant up
diff --git a/README.vagrant.rst b/README.vagrant.rst
new file mode 100644
index 000000000..5c6dc3e06
--- /dev/null
+++ b/README.vagrant.rst
@@ -0,0 +1,48 @@
+==============================
+Vagrant support for developers
+==============================
+
+Bifrost vagrant file for developers can be found in the
+``tools/vagrant_dev_env`` directory. Running ``vagrant up`` from
+within this folder will bring up an Ubuntu Trusty box with Bifrost
+installed.
+
+By default, the VM will have three interfaces:
+
+- **eth0** - connected to a NAT network
+- **eth1** - connected to Host-only network named: vboxnet1
+- **eth2** - bridged - adapter must be set in Vagrantfile
+
+-------------------------
+Walkthrough done on OS X
+-------------------------
+Setup vagrant by:
+
+- Installing git
+- Installing virtualbox
+- Installing vagrant
+- Installing ansible
+
+Configure Vagrant with the correct box::
+
+  vagrant box add ubuntu/trusty64
+
+Clone bifrost repo::
+
+  git clone https://github.com/openstack/bifrost.git
+
+Change into the bifrost directory::
+
+  cd bifrost/tools/vagrant_dev_env
+
+Edit the Vagrantfile:
+
+- Change the ``bifrost.vm.network`` ``public_network`` value to a
+  valid network interface to allow Bare Metal connectivity
+- Change ``public_key`` to correct key name
+- Change ``network_interface`` to match your needs
+
+
+Boot the VM with::
+
+  vagrant up
diff --git a/doc/source/Vagrant.rst b/doc/source/Vagrant.rst
deleted file mode 100644
index 832284f99..000000000
--- a/doc/source/Vagrant.rst
+++ /dev/null
@@ -1 +0,0 @@
-.. include:: ../../README.vagrant
diff --git a/doc/source/index.rst b/doc/source/index.rst
index ab4a0cd8b..1f74cb167 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -9,7 +9,7 @@ Contents:
    readme
    contributing
    troubleshooting
-   Vagrant
+   vagrant
    deploy/dhcp
    offline-install
 
diff --git a/doc/source/vagrant.rst b/doc/source/vagrant.rst
new file mode 100644
index 000000000..3b3c48063
--- /dev/null
+++ b/doc/source/vagrant.rst
@@ -0,0 +1 @@
+.. include:: ../../README.vagrant.rst