From e18a18872325a2dafb28848e272ba0d3f3aad8c9 Mon Sep 17 00:00:00 2001 From: Brint O'Hearn Date: Thu, 30 Mar 2017 23:09:30 -0500 Subject: [PATCH] Spell fixes in docs (#740) --- docs/developer/index.rst | 3 +-- docs/developer/plugins/index.rst | 6 +++--- docs/production/index.rst | 4 ++-- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/developer/index.rst b/docs/developer/index.rst index c6c04f59..bd43d8ca 100644 --- a/docs/developer/index.rst +++ b/docs/developer/index.rst @@ -86,7 +86,7 @@ You'll likely want to make some changes to the default configuration (we recomme lemur upgrade -.. note:: The ``upgrade`` shortcut is simply a shorcut to Alembic's upgrade command. +.. note:: The ``upgrade`` shortcut is simply a shortcut to Alembic's upgrade command. Coding Standards @@ -285,4 +285,3 @@ Internals :maxdepth: 2 internals/lemur - diff --git a/docs/developer/plugins/index.rst b/docs/developer/plugins/index.rst index f2e2e22a..e9fc7936 100644 --- a/docs/developer/plugins/index.rst +++ b/docs/developer/plugins/index.rst @@ -180,7 +180,7 @@ The schema for defining plugin options are pretty straightforward: - **Type** there are currently four supported variable types - **Int** creates an html integer box for the user to enter integers into - **Str** creates a html text input box - - **Boolean** creates a checkbox for the user to signify truithyness + - **Boolean** creates a checkbox for the user to signify truthiness - **Select** creates a select box that gives the user a list of options - When used a `available` key must be provided with a list of selectable options - **Required** determines if this option is required, this **must be a boolean value** @@ -196,7 +196,7 @@ Notification ------------ Lemur includes the ability to create Email notifications by **default**. These notifications -currently come in the form of expiration noticies. Lemur periodically checks certifications expiration dates and +currently come in the form of expiration notices. Lemur periodically checks certifications expiration dates and determines if a given certificate is eligible for notification. There are currently only two parameters used to determine if a certificate is eligible; validity expiration (date the certificate is no longer valid) and the number of days the current date (UTC) is from that expiration date. @@ -207,7 +207,7 @@ are trying to create a new notification type (audit, failed logins, etc.) this w You would also then need to build additional code to trigger the new notification type. The second is `ExpirationNotificationPlugin`, this object inherits from `NotificationPlugin` object. -You will most likely want to base your plugin on, if you want to add new channels for expiration notices (Slack, Hipcat, Jira, etc.). It adds default options that are required by +You will most likely want to base your plugin on, if you want to add new channels for expiration notices (Slack, HipChat, Jira, etc.). It adds default options that are required by all expiration notifications (interval, unit). This interface expects for the child to define the following function:: def send(self, notification_type, message, targets, options, **kwargs): diff --git a/docs/production/index.rst b/docs/production/index.rst index 93d77b61..a98ee691 100644 --- a/docs/production/index.rst +++ b/docs/production/index.rst @@ -50,7 +50,7 @@ The amount of effort you wish to expend ensuring that Lemur has good entropy to If you wish to generate more entropy for your system we would suggest you take a look at the following resources: - `WES-entropy-client `_ -- `haveaged `_ +- `haveged `_ For additional information about OpenSSL entropy issues: @@ -316,4 +316,4 @@ Example cron entries:: 0 22 * * * lemuruser export LEMUR_CONF=/Users/me/.lemur/lemur.conf.py; /www/lemur/bin/lemur notify */15 * * * * lemuruser export LEMUR_CONF=/Users/me/.lemur/lemur.conf.py; /www/lemur/bin/lemur sync -s all - 0 22 * * * lemuruser export LEMUR_CONF=/Users/me/.lemur/lemur.conf.py; /www/lemur/bin/lemur check_revoked \ No newline at end of file + 0 22 * * * lemuruser export LEMUR_CONF=/Users/me/.lemur/lemur.conf.py; /www/lemur/bin/lemur check_revoked