Documentation: Changed "Provider" to "Provider Plugin", Formatting, Elaboration #91

Closed
wants to merge 9 commits into
from

Conversation

Projects
None yet
2 participants
Contributor

m00dawg commented May 9, 2013

Changed Provide to Provider Plugin in most of the documentation and began working on updating the provider plugin configuration pages. Also added a few examples in various places.

m00dawg added some commits May 2, 2013

@m00dawg m00dawg Updated explanation of Holland, added section
Updated the explanation of Holland in the intro section and also added
a (currently incomplete) Installation section.
1be101c
@m00dawg m00dawg Updated parts of the docs to use provider-plugin
Various parts of the documentation now refers to providers as
provider plugins. Also made minor grammatical updates.
ad0254d
@m00dawg m00dawg Started work on refactoring the provider configs 90633d5
@m00dawg m00dawg Expanded on provider plugins, added examples da7b79d
@m00dawg m00dawg All parameters now use .. describe:: in config.rst 25f2941
@m00dawg m00dawg Lightly exapnded on plugin explanation 003b710

@abg abg commented on the diff May 10, 2013

docs/source/config.rst
@@ -29,91 +29,114 @@ two sections :ref:`[holland]<holland-config>` and :ref:`[logging]<logging-config
[holland]
^^^^^^^^^
-.. describe:: plugin-dirs
+.. _holland-config-plugin_dirs:
+
+.. describe:: plugin_dirs = [directory1],[directory2],...,[directoryN]
@abg

abg May 10, 2013

Contributor

This should probably be deprecated and we should probably document it as such. This is an artifact from an early version of holland's entry points plugin system. I believe we add these as additional directories for holland to search, but I can't really think of a good reason for anyone to use this. holland-core definitely never uses this and never will for any packages plugins.

@abg abg commented on the diff May 10, 2013

docs/source/intro.rst
python-setuptools.
Note that other plugins may have additional dependency requirements.
+
+Installation
+------------
+Holland has ready-made packages available for Red-Hat, CentOS, and Ubuntu
+which are available via the OpenSUSE build system
+`here <http://download.opensuse.org/repositories/home:/holland-backup/>`_.
+Other distributions may download the generic tarball
+`here <http://hollandbackup.org/releases/stable/1.0/>`_ or pull directly
+from the GitHub tree `here <https://github.com/holland-backup/holland>`_.
+
@abg

abg May 10, 2013

Contributor

We probably should document how to setup these repos. I think this is on the old busted wiki.

Maybe something simple like:

$ cat > /etc/apt/sources.list.d/holland.list <<EOF
deb http://download.opensuse.org/repositories/home:/holland-backup/xUbuntu_$(lsb_release -sr) ./
EOF
$ curl http://download.opensuse.org/repositories/home:/holland-backup/xUbuntu_$(lsb_release -sr)/Release.key | sudo apt-key add -
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  1023  100  1023    0     0   3625      0 --:--:-- --:--:-- --:--:--  7359
OK
@m00dawg

m00dawg May 13, 2013

Contributor

On May 10, 2013, at 5:00 PM, Andrew Garner wrote:

In docs/source/intro.rst:

python-setuptools.

Note that other plugins may have additional dependency requirements.
+
+Installation
+------------
+Holland has ready-made packages available for Red-Hat, CentOS, and Ubuntu
+which are available via the OpenSUSE build system
+here <http://download.opensuse.org/repositories/home:/holland-backup/>.
+Other distributions may download the generic tarball
+here <http://hollandbackup.org/releases/stable/1.0/>
or pull directly
+from the GitHub tree here <https://github.com/holland-backup/holland>_.
+
We probably should document how to setup these repos. I think this is on the old busted wiki.

Maybe something simple like:

$ cat > /etc/apt/sources.list.d/holland.list <<EOF
deb http://download.opensuse.org/repositories/home:/holland-backup/xUbuntu_$(lsb_release -sr) ./
EOF
$ curl http://download.opensuse.org/repositories/home:/holland-backup/xUbuntu_$(lsb_release -sr)/Release.key | sudo apt-key add -
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 1023 100 1023 0 0 3625 0 --:--:-- --:--:-- --:--:-- 7359
OK

Reply to this email directly or view it on GitHub.

Yes that was a bit purposefully incomplete. I wasn't sure what our longer term plans were for that? Is OpenSUSE going to be the place to go (I would guess that is the case)? If so, both these docs can be updated as well as hollandbackup.org directly. It's a bit confusing to get the right version right now, so I thought this might warrant some additional discussion. Another curiosity was EPEL. I know BJ was working on that but it's not in the repository yet (unless I missed it which is entirely possible :) ). If that's still in the works let me know what I can do to help with that. I'd much rather have the instructions say go to EPEL first (and say grab it from OpenSUSE for a development version or for an early adopter).

To avoid too much traffic on the list, I looked at your other suggestions and they are sensible so I'll make those changes today most likely.

@abg abg commented on an outdated diff May 10, 2013

docs/source/overview.rst
Backup-Sets
^^^^^^^^^^^
-Each backup-set implements exactly one provider and will inherit the default
-values of that provider. These values can be overridden to adjust the
-behavior of the backup set. This includes defining what databases or tables
-to include (or exclude) in the backup, the type of compression used (if
-any), what locking method to use, among other things.
+Each backup-set implements a backup plugin (provider) and often some helper
+plugins for things such as compression. Plugins come with a set of defaults
+such that only values that need to be overridden need to be specified,
+although it is perfectly acceptable to specify options that are already
+default - one would merely be stating the obvious. Doing so woudl also
@abg

abg May 10, 2013

Contributor

woudl -> would

@abg abg commented on an outdated diff May 10, 2013

docs/source/overview.rst
-Providers essentially provide a backup service for use in a backup set.
-As of Holland 0.5, there are 5 providers:
+Provider plugins provide a backup service for use in a backup set. The
@abg

abg May 10, 2013

Contributor

The are -> They are

m00dawg closed this May 13, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment