From: Matías Aguirre <matiasaguirre@gmail.com>
Date: Mon, 9 Jul 2012 04:40:52 +0000 (-0300)
Subject: Small doc changes. Refs #370
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=acc18d804e93b247ddf7f5a20d588745c35c0ba4;p=django-social-auth.git

Small doc changes. Refs #370
---

diff --git a/README.rst b/README.rst
index 7e26d9b..be4f2ed 100644
--- a/README.rst
+++ b/README.rst
@@ -421,6 +421,26 @@ uppercase and replace ``-`` with ``_``), here's the supported settings so far::
         SOCIAL_AUTH_LOGIN_REDIRECT_URL
         SOCIAL_AUTH_INACTIVE_USER_URL
 
+- The ORM models can be replaced by providing the name of an alternate module
+  for the ``SOCIAL_AUTH_MODELS`` setting. The default is
+  ``'social_auth.db.django_models'``, which defines the Django ORM models that
+  were originally defined to implement Social Auth's storage. The app provides
+  an example alternate based on `MongoEngine`_. You can use it by setting::
+
+    SOCIAL_AUTH_MODELS = 'social_auth.db.mongoengine_models'
+
+  Make sure you've followed the instructions for `MongoEngine Django
+  integration`_, as you're now utilizing that user model.
+
+  The `MongoEngine_` backend was developed and tested with version 0.6.10 of
+  `MongoEngine_`.
+
+  Alternate storage models implementations currently follow a tight pattern of
+  models that behave near or identical to Django ORM models. It is currently
+  not decoupled from this pattern by any abstraction layer. If you would like
+  to implement your own alternate, please see the
+  ``social_auth.db.django_models`` and ``social_auth.db.mongoengine_models``
+  modules for guidance.
 
 Authentication Pipeline
 -----------------------
@@ -1269,6 +1289,10 @@ Attributions to whom deserves:
 
   - Evernote support
 
+- estebistec_ (Steven Cummings)
+
+  - Overrideable models feature
+
 
 Copyrights
 ----------
@@ -1374,3 +1398,6 @@ Base work is copyrighted by:
 .. _Odnoklassniki OAuth: http://dev.odnoklassniki.ru/wiki/display/ok/The+OAuth+2.0+Protocol
 .. _authentication for VKontakte applications: http://www.ikrvss.ru/2011/11/08/django-social-auh-and-vkontakte-application/
 .. _Facebook Canvas Application Authentication: http://www.ikrvss.ru/2011/09/22/django-social-auth-and-facebook-canvas-applications/
+.. _MongoEngine: http://mongoengine.org
+.. _MongoEngine Django integration: http://mongoengine-odm.readthedocs.org/en/latest/django.html
+.. _estebistec: https://github.com/estebistec
diff --git a/doc/configuration.rst b/doc/configuration.rst
index 0a6d127..d697589 100644
--- a/doc/configuration.rst
+++ b/doc/configuration.rst
@@ -310,25 +310,24 @@ uppercase and replace ``-`` with ``_``), here's the supported settings so far::
 
 - The ORM models can be replaced by providing the name of an alternate module
   for the ``SOCIAL_AUTH_MODELS`` setting. The default is
-  ``'social_auth.django_models'``, which defines the Django ORM models that
-  were originally defined to implement Social Auth's storage. Social auth
-  provides an example alternate based on `MongoEngine`_. You can use it by
-  setting::
+  ``'social_auth.db.django_models'``, which defines the Django ORM models that
+  were originally defined to implement Social Auth's storage. The app provides
+  an example alternate based on `MongoEngine`_. You can use it by setting::
 
-    SOCIAL_AUTH_MODELS = 'social_auth.mongoengine_models'
+    SOCIAL_AUTH_MODELS = 'social_auth.db.mongoengine_models'
 
-  Make sure you've followed the instructions for
-  `MongoEngine Django integration`_, as you're now utilizing that user model.
+  Make sure you've followed the instructions for `MongoEngine Django
+  integration`_, as you're now utilizing that user model.
 
-  The MongoEngine backing was developed and tested with version 0.6.10 of
-  MongoEngine.
+  The `MongoEngine_` backend was developed and tested with version 0.6.10 of
+  `MongoEngine_`.
 
   Alternate storage models implementations currently follow a tight pattern of
   models that behave near or identical to Django ORM models. It is currently
   not decoupled from this pattern by any abstraction layer. If you would like
   to implement your own alternate, please see the
-  ``social_auth.django_models`` and ``social_auth.mongoengine_models`` modules
-  for guidance.
+  ``social_auth.db.django_models`` and ``social_auth.db.mongoengine_models``
+  modules for guidance.
 
 .. _Model Manager: http://docs.djangoproject.com/en/dev/topics/db/managers/#managers
 .. _Login URL: http://docs.djangoproject.com/en/dev/ref/settings/?from=olddocs#login-url
diff --git a/doc/contributions.rst b/doc/contributions.rst
index d832cd4..bfba6e4 100644
--- a/doc/contributions.rst
+++ b/doc/contributions.rst
@@ -46,6 +46,9 @@ niQo_ (Nicolas Quiénot)
 hassek_ (Tomas Henriquez)
   * Evernote support
 
+estebistec_ (Steven Cummings)
+  * Overrideable models feature
+
 .. _caioariede: https://github.com/caioariede
 .. _krvss: https://github.com/krvss
 .. _jezdez: https://github.com/jezdez
@@ -61,3 +64,4 @@ hassek_ (Tomas Henriquez)
 .. _python-oauth2: https://github.com/simplegeo/python-oauth2
 .. _niQo: https://github.com/niQo
 .. _hassek: https://github.com/hassek
+.. _estebistec: https://github.com/estebistec