From 2fc6d4cd2186bce550115b43b9ee89e4b8ef73e5 Mon Sep 17 00:00:00 2001 From: Robert Picard Date: Tue, 6 Oct 2015 15:05:05 -0700 Subject: [PATCH] Fix a handful of typos in documentation As I was reading through the docs I made note of grammar issues and typos I saw. Not a huge deal but might as well fix what I noticed. --- docs/administration/index.rst | 24 ++++++++++++------------ docs/guide/index.rst | 2 +- docs/production/index.rst | 12 ++++++------ docs/quickstart/index.rst | 16 ++++++++-------- lemur/auth/views.py | 2 +- 5 files changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/administration/index.rst b/docs/administration/index.rst index 55622d6f..3bcceed7 100644 --- a/docs/administration/index.rst +++ b/docs/administration/index.rst @@ -72,7 +72,7 @@ Basic Configuration .. data:: LEMUR_TOKEN_SECRET :noindex: - The TOKEN_SECRET is the secret used to create JWT tokens that are given out to users. This should be securely generated and be kept private. + The TOKEN_SECRET is the secret used to create JWT tokens that are given out to users. This should be securely generated and kept private. :: @@ -210,13 +210,13 @@ Authority Options ----------------- Authorities will each have their own configuration options. There is currently just one plugin bundled with Lemur, -Verisign/Symantec. Additional plugins may define additional options. Refer to the plugins own documentation +Verisign/Symantec. Additional plugins may define additional options. Refer to the plugin's own documentation for those plugins. .. data:: VERISIGN_URL :noindex: - This is the url for the verisign API + This is the url for the Verisign API .. data:: VERISIGN_PEM_PATH @@ -256,7 +256,7 @@ for those plugins. Authentication -------------- -Lemur currently supports Basic Authentication and Ping OAuth2 out of the box, additional flows can be added relatively easily. +Lemur currently supports Basic Authentication and Ping OAuth2 out of the box. Additional flows can be added relatively easily. If you are not using Ping you do not need to configure any of these options. For more information about how to use social logins, see: `Satellizer `_ @@ -295,7 +295,7 @@ For more information about how to use social logins, see: `Satellizer ` for more details on using Supervis Syncing ------- -Lemur uses periodic sync tasks to make sure it is up-to-date with it's environment. As always things can change outside +Lemur uses periodic sync tasks to make sure it is up-to-date with its environment. As always things can change outside of Lemur, but we do our best to reconcile those changes. .. code-block:: bash @@ -254,7 +254,7 @@ If you're familiar with Python you'll quickly find yourself at home, and even mo ``lemur`` command is just a simple wrapper around Flask's ``manage.py``, which means you get all of the power and flexibility that goes with it. -Some of those which you'll likely find useful are: +Some of the features which you'll likely find useful are: lock ~~~~ @@ -273,6 +273,6 @@ What's Next? Get familiar with how Lemur works by reviewing the :doc:`../guide/index`. When you're ready see :doc:`../production/index` for more details on how to configure Lemur for production. -Remember the above just gets you going, but for production there are several different security considerations to take into account, -remember Lemur is handling sensitive data and security is imperative. +The above just gets you going, but for production there are several different security considerations to take into account. +Remember, Lemur is handling sensitive data and security is imperative. diff --git a/lemur/auth/views.py b/lemur/auth/views.py index c5799673..8f93554e 100644 --- a/lemur/auth/views.py +++ b/lemur/auth/views.py @@ -35,7 +35,7 @@ class Login(Resource): Authorization:Bearer - Tokens have a set expiration date. You can inspect the token expiration be base64 decoding the token and inspecting + Tokens have a set expiration date. You can inspect the token expiration by base64 decoding the token and inspecting it's contents. .. note:: It is recommended that the token expiration is fairly short lived (hours not days). This will largely depend \