From e80ad46972b055a19b142ca93873086abefcbdb7 Mon Sep 17 00:00:00 2001 From: Anders Ingemann Date: Thu, 16 Apr 2015 23:39:14 +0200 Subject: [PATCH] Repeat index/README pattern for plugins & providers --- bootstrapvz/plugins/README.rst | 8 ++++++++ bootstrapvz/providers/README.rst | 8 ++++++++ docs/plugins/index.rst | 14 +++----------- docs/providers/index.rst | 3 +++ 4 files changed, 22 insertions(+), 11 deletions(-) create mode 100644 bootstrapvz/plugins/README.rst create mode 100644 bootstrapvz/providers/README.rst diff --git a/bootstrapvz/plugins/README.rst b/bootstrapvz/plugins/README.rst new file mode 100644 index 0000000..df46d3c --- /dev/null +++ b/bootstrapvz/plugins/README.rst @@ -0,0 +1,8 @@ +Plugins are a key feature of bootstrap-vz. Despite their small size +(most plugins do not exceed 100 source lines of code) they can modify +the behavior of bootstrapped systems to a great extent. + +Below you will find documentation for all plugins available for +bootstrap-vz. If you cannot find what you are looking for, consider +`developing it yourself `__ and +contribute to this list! diff --git a/bootstrapvz/providers/README.rst b/bootstrapvz/providers/README.rst new file mode 100644 index 0000000..4ffd326 --- /dev/null +++ b/bootstrapvz/providers/README.rst @@ -0,0 +1,8 @@ +Providers in bootstrap-vz represent various cloud providers and virtual machines. + +bootstrap-vz is an extensible platform with loose coupling and a significant +amount of tooling, which allows for painless implementation of new providers. + +The virtualbox provider for example is implemented in only 89 lines of python, +since most of the building blocks are a part of the common task library. +Only the kernel and guest additions installation are specific to that provider. diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index 208c1d3..1d62e4f 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -1,19 +1,11 @@ - Plugins ======= -Plugins are a key feature of bootstrap-vz. Despite their small size -(most plugins do not exceed 100 source lines of code) they can modify -the behavior of bootstrapped systems to a great extent. - -Below you will find documentation for all plugins available for -bootstrap-vz. If you cannot find what you are looking for, consider -`developing it yourself `__ and -contribute to this list! - - .. toctree:: :maxdepth: 1 + :hidden: :glob: * + +.. include:: ../../bootstrapvz/plugins/README.rst diff --git a/docs/providers/index.rst b/docs/providers/index.rst index 7bf1ed5..5b11a93 100644 --- a/docs/providers/index.rst +++ b/docs/providers/index.rst @@ -3,6 +3,9 @@ Providers .. toctree:: :maxdepth: 1 + :hidden: :glob: * + +.. include:: ../../bootstrapvz/providers/README.rst