From 65ddee99d735414812549ac82529b47d2eaa7005 Mon Sep 17 00:00:00 2001 From: Anders Ingemann Date: Sun, 12 Apr 2015 14:32:47 +0200 Subject: [PATCH] Fix some links --- CONTRIBUTING.rst | 14 +++---- README.rst | 43 +++++++++++---------- bootstrapvz/providers/ec2/README.rst | 4 +- bootstrapvz/providers/virtualbox/README.rst | 2 +- manifests/README.rst | 12 +++--- 5 files changed, 39 insertions(+), 36 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 7554a35..9c853f5 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -6,15 +6,15 @@ Sending pull requests Do you want to contribute to the bootstrap-vz project? Nice! Here is the basic workflow: -+ Read the [development guidelines](http://bootstrap-vz.readthedocs.org/en/master/guidelines.html) ++ Read the `development guidelines `__ + Fork this repository. + Make any changes you want/need. -+ Check the coding style of your changes using [tox](http://tox.readthedocs.org/) by running `tox -e flake8` ++ Check the coding style of your changes using `tox `__ by running `tox -e flake8` and fix any warnings that may appear. - This check will be repeated by [Travis CI](https://travis-ci.org/andsens/bootstrap-vz) + This check will be repeated by `Travis CI `__ once you send a pull request, so it's better if you check this beforehand. + If the change is significant (e.g. a new plugin, manifest setting or security fix) - add your name and contribution to the [CHANGELOG](CHANGELOG). + add your name and contribution to the `changelog `__. + Commit your changes. + Squash the commits if needed. For instance, it is fine if you have multiple commits describing atomic units of work, but there's no reason to have many little commits just because of corrected typos. @@ -61,7 +61,7 @@ value to the bootstrap-vz codebase. This allows others to easily reproduce any setup other people are running and makes it possible to share manifests. `The official debian EC2 images `_ + profile?id=890be55d-32d8-4bc8-9042-2b4fd83064d5>`__ for example can be reproduced using the manifests available in the manifest directory of bootstrap-vz. @@ -107,7 +107,7 @@ value to the bootstrap-vz codebase. This allows other tasks to interleave with the control-flow and add extended functionality (e.g. because volume creation and mounting are two separate tasks, `the prebootstrapped plugin - `_ + `__ can replace the volume creation task with a task of its own that creates a volume from a snapshot instead, but still reuse the mount task). @@ -152,7 +152,7 @@ guidelines. There however a few exceptions: + Ignore ``W191``: Indent with tabs not spaces The codebase can be checked for any violations quite easily, since those rules are already specified in the -`tox `_ configuration file. +`tox `__ configuration file. :: tox -e flake8 diff --git a/README.rst b/README.rst index 9a54e5c..1e08507 100644 --- a/README.rst +++ b/README.rst @@ -18,14 +18,14 @@ bootstrapper reached its limits. Documentation ------------- -The end-user documentation for bootstrap-vz is available at -`andsens.github.io/bootstrap-vz `__. +The documentation for bootstrap-vz is available at +`bootstrap-vz.readthedocs.org `__. There, you can discover `what the -dependencies `__ +dependencies `__ for a specific cloud provider are, `see a list of available -plugins `__ and +plugins `__ and learn `how you create a -manifest `__. +manifest `__. Installation ------------ @@ -38,7 +38,7 @@ python dependencies by running ``python setup.py install``. However, depending on what kind of image you'd like to bootstrap, there are other debian package dependencies as well, at the very least you will need ``debootstrap``. -`The documentation `__ +`The documentation `__ explains this in more detail. Note that bootstrap-vz will tell you which tools it requires when they @@ -68,7 +68,7 @@ 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 `__ +If you want to use the `minimize\_size `__ plugin, you will have to install the ``zerofree`` package and `VMWare Workstation `__ as well. @@ -113,16 +113,18 @@ Dependencies ------------ bootstrap-vz has a number of dependencies depending on the target -platform and `the selected plugins `__. At a bare minimum -the following python libraries are needed: \* -`termcolor `__ \* -`fysom `__ \* -`jsonschema `__ \* -`docopt `__ \* -`pyyaml `__ To bootstrap Debian -itself -`debootstrap `__ is -needed as well. +platform and `the selected plugins `__. +At a bare minimum the following python libraries are needed: + +* `termcolor `__ +* `fysom `__ +* `jsonschema `__ +* `docopt `__ +* `pyyaml `__ + +To bootstrap Debian itself +`debootstrap `__ +is needed as well. Any other requirements are dependent upon the manifest configuration and are detailed in the corresponding sections of the documentation. @@ -139,7 +141,8 @@ bootstrap-vz internals can be found at Contributing ------------ -Contribution guidelines are described on the -`CONTRIBUTING `__ file. There's also a `topic on the -documentation `__ +Contribution guidelines are described in the documentation under +`Contributing `__. +There's also +`a topic `__ regarding the coding style. diff --git a/bootstrapvz/providers/ec2/README.rst b/bootstrapvz/providers/ec2/README.rst index 7c79201..05b63e8 100644 --- a/bootstrapvz/providers/ec2/README.rst +++ b/bootstrapvz/providers/ec2/README.rst @@ -7,8 +7,8 @@ once it is done and registers it as an AMI. EBS volume backing only works on an EC2 host while S3 backed volumes *should* work locally (at this time however they do not, a fix is in the works). -Unless `the cloud-init plugin `__ is used, -special startup scripts will be installed that automatically fetch the +Unless `the cloud-init plugin `__ +is used, special startup scripts will be installed that automatically fetch the configured authorized\_key from the instance metadata and save or run any userdata supplied (if the userdata begins with ``#!`` it will be run). diff --git a/bootstrapvz/providers/virtualbox/README.rst b/bootstrapvz/providers/virtualbox/README.rst index b3e3d16..154199b 100644 --- a/bootstrapvz/providers/virtualbox/README.rst +++ b/bootstrapvz/providers/virtualbox/README.rst @@ -9,4 +9,4 @@ interoperability (e.g. *should* support vdi files, but since they have no identifier URL not even VirtualBox itself can import them). VirtualBox Guest Additions can be installed automatically if the ISO is `provided in the -manifest `__. +manifest `__. diff --git a/manifests/README.rst b/manifests/README.rst index 3d5c1b5..d644979 100644 --- a/manifests/README.rst +++ b/manifests/README.rst @@ -39,7 +39,7 @@ name of the provider itself. - **``name``**: target virtualization platform of the installation *``required``* -Consult the `providers `__ section of the documentation +Consult the `providers `__ section of the documentation for a list of valid values. Bootstrapper @@ -76,8 +76,8 @@ are 4 possible settings: Accepts a list of package names. *``optional``* - **``guest_additions``**: This setting is only relevant for the - `virtualbox provider `__. It specifies the - path to the VirtualBox Guest Additions ISO, which, when specified, + `virtualbox provider `__. + It specifies the path to the VirtualBox Guest Additions ISO, which, when specified, will be mounted and used to install the VirtualBox Guest Additions. *``optional``* @@ -216,7 +216,7 @@ boot, root and swap. optional setting overrides the command bootstrap-vz would normally use to format the partition. The command is specified as a string array where each option/argument is an item in that array (much - like the `image\_commands `__ plugin). + like the `image\_commands `__ plugin). *``optional``* The following variables are available: - **``{fs}``**: The filesystem of the partition. - **``{device_path}``**: The device path of the partition. @@ -237,5 +237,5 @@ Plugins ~~~~~~~ The plugins section is a map of plugin names to whatever configuration a -plugin requires. Go to the `plugin section `__ of the -documentation, to see the configuration for a specific plugin. +plugin requires. Go to the `plugin section `__ +of the documentation, to see the configuration for a specific plugin.