From 5942c665bca183b6baec1ffadf421b0d3a8ea95b Mon Sep 17 00:00:00 2001 From: Anders Ingemann Date: Mon, 20 Apr 2015 13:04:17 +0200 Subject: [PATCH] Fix some indentation and links --- README.rst | 36 ++++++++++++++++++------------------ tests/README.rst | 7 ++++++- 2 files changed, 24 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index 1555143..81b0768 100644 --- a/README.rst +++ b/README.rst @@ -24,7 +24,8 @@ There, you can discover `what the dependencies <#dependencies>`__ for a specific cloud provider are, `see a list of available plugins `__ and learn `how you create a manifest `__. -Note to developers: `The documentaion `__ is generated in a rather peculiar and nifty way. +Note to developers: `The documentaion `__ is generated in +a rather peculiar and nifty way. Installation ------------ @@ -65,7 +66,7 @@ quits the process. VirtualBox Vagrant ~~~~~~~~~~~~~~~~~~ -:: +.. code:: sh user@host:~$ sudo -i # become root root@host:~# git clone https://github.com/andsens/bootstrap-vz.git # Clone the repo @@ -73,10 +74,10 @@ VirtualBox Vagrant root@host:~# pip install termcolor jsonschema fysom docopt pyyaml # Install python dependencies root@host:~# bootstrap-vz/bootstrap-vz bootstrap-vz/manifests/virtualbox-vagrant.manifest.yml -If you want to use the `minimize\_size `__ -plugin, you will have to install the ``zerofree`` package and `VMWare -Workstation `__ -as well. +If you want to use the `minimize\_size `__ plugin, +you will have to install the ``zerofree`` package and `VMWare Workstation`__ as well. + +__ https://my.vmware.com/web/vmware/info/slug/desktop_end_user_computing/vmware_workstation/10_0 Amazon EC2 EBS backed AMI ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -109,11 +110,12 @@ occurred you can simply correct the problem that caused it and rerun everything, there will be no leftovers from the previous run (as always there are of course rare/unlikely exceptions to that rule). The error messages should always give you a strong hint at what is wrong, if that -is not the case please consider `opening an -issue `__ and attach +is not the case please consider `opening an issue`__ and attach both the error message and your manifest (preferably as a gist or similar). +__ https://github.com/andsens/bootstrap-vz/issues + Dependencies ------------ @@ -127,9 +129,9 @@ At a bare minimum the following python libraries are needed: * `docopt `__ * `pyyaml `__ -To bootstrap Debian itself -`debootstrap `__ -is needed as well. +To bootstrap Debian itself `debootstrap`__ is needed as well. + +__ https://packages.debian.org/wheezy/debootstrap Any other requirements are dependent upon the manifest configuration and are detailed in the corresponding sections of the documentation. @@ -140,14 +142,12 @@ Developers ---------- The API documentation, development guidelines and an explanation of -bootstrap-vz internals can be found at -`bootstrap-vz.readthedocs.org `__. +bootstrap-vz internals can be found at `bootstrap-vz.readthedocs.org`__. + +__ http://bootstrap-vz.readthedocs.org/en/master/developers Contributing ------------ -Contribution guidelines are described in the documentation under -`Contributing `__. -There's also -`a topic `__ -regarding the coding style. +Contribution guidelines are described in the documentation under `Contributing `__. +There's also a topic regarding `the coding style `__. diff --git a/tests/README.rst b/tests/README.rst index 07a3b69..808c60b 100644 --- a/tests/README.rst +++ b/tests/README.rst @@ -1,2 +1,7 @@ The testing framework consists of two parts: -The unit tests and the integration tests +The unit tests and the integration tests. + +The `unit tests `__ are responsible for testing individual +parts of bootstrap-vz, +while the `integration tests `__ test entire manifests by +bootstrapping and booting them.