From 162f41d45ef8637a5d5bcf6c1bc9d59a63568112 Mon Sep 17 00:00:00 2001 From: James Kasten Date: Mon, 30 Mar 2015 18:18:59 -0700 Subject: [PATCH 1/2] update/cleanup docs --- docs/contributing.rst | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index e3b81b3d4..cf5d95289 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -126,26 +126,27 @@ Installers and Authenticators will oftentimes be the same class/object. Installers and Authenticators are kept separate because it should be possible to use the `~.StandaloneAuthenticator` (it sets up its own Python server to perform challenges) with a program that -cannot solve challenges itself. (I am imagining MTA installers). +cannot solve challenges itself. (Imagine MTA installers). + + +Installer Development +--------------------- + +There are a few existing classes that may be beneficial while +developing a new `~letsencrypt.client.interfaces.IInstaller`. +Installer's aimed to reconfigure UNIX servers may use Augeas for +configuration parsing and can inherit from `~.AugeasConfigurator` class +to handle much of the interface. Installers that are unable to use +Augeas may still use the `~.Reverter` class to handle configuration +checkpoints and rollback. Display ~~~~~~~ -We currently offer a pythondialog and "text" mode for displays. I have -rewritten the interface which should be merged within the next day -(the rewrite is in the revoker branch of the repo and should be merged -within the next day). Display plugins implement -`~letsencrypt.client.interfaces.IDisplay` interface. - - -Augeas ------- - -Some plugins, especially those designed to reconfigure UNIX servers, -can take inherit from `~.AugeasConfigurator` class in order to more -efficiently handle common operations on UNIX server configuration -files. +We currently offer a pythondialog and "text" mode for displays. Display +plugins implement the `~letsencrypt.client.interfaces.IDisplay` +interface. .. _coding-style: From ce3cabfd2f474c6d44cdbd47a7163e55a4eb3e70 Mon Sep 17 00:00:00 2001 From: James Kasten Date: Mon, 30 Mar 2015 18:28:36 -0700 Subject: [PATCH 2/2] Fix mistake, rework sentence --- docs/contributing.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index cf5d95289..86d018f46 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -134,11 +134,11 @@ Installer Development There are a few existing classes that may be beneficial while developing a new `~letsencrypt.client.interfaces.IInstaller`. -Installer's aimed to reconfigure UNIX servers may use Augeas for +Installers aimed to reconfigure UNIX servers may use Augeas for configuration parsing and can inherit from `~.AugeasConfigurator` class to handle much of the interface. Installers that are unable to use -Augeas may still use the `~.Reverter` class to handle configuration -checkpoints and rollback. +Augeas may still find the `~.Reverter` class helpful in handling +configuration checkpoints and rollback. Display