starred/certbot-certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-08-03 03:41:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #330 from letsencrypt/cleanup_contributing

Browse Source 
update/cleanup docs
This commit is contained in:
James Kasten
2015-03-31 11:44:08 -07:00
parent 495a090503 ce3cabfd2f
commit bbcfda59e4
1 changed files with 16 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/contributing.rst
+16 -15
View File
@@ -126,26 +126,27 @@ Installers and Authenticators will oftentimes be the same
class/object. Installers and Authenticators are kept separate because class/object. Installers and Authenticators are kept separate because
it should be possible to use the `~.StandaloneAuthenticator` (it sets it should be possible to use the `~.StandaloneAuthenticator` (it sets
up its own Python server to perform challenges) with a program that 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`.
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 find the `~.Reverter` class helpful in handling
configuration checkpoints and rollback.
Display Display
~~~~~~~ ~~~~~~~
We currently offer a pythondialog and "text" mode for displays. I have We currently offer a pythondialog and "text" mode for displays. Display
rewritten the interface which should be merged within the next day plugins implement the `~letsencrypt.client.interfaces.IDisplay`
(the rewrite is in the revoker branch of the repo and should be merged interface.
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.
.. _coding-style: .. _coding-style: