Permalink
Browse files

Documentation updates: add reference links, minor reorganization.

  • Loading branch information...
1 parent 7d2d59b commit d36597410c7d7a011530a50e0c947ae30117444c @reeedo reeedo committed Mar 18, 2013
@@ -0,0 +1,6 @@
+Pyramid Auth with Akhet and SQLAlchemy
+======================================
+
+Learn how to set up Pyramid authorization using Akhet and SQLAlchemy at
+http://pyramid.chromaticleaves.com/simpleauth/.
+
@@ -0,0 +1,7 @@
+Auth Tutorial
+=============
+
+See Michael Merickel's authentication/authorization tutorial at
+http://michael.merickel.org/projects/pyramid_auth_demo/ with code on Github at
+https://github.com/mmerickel/pyramid_auth_demo.
+
View
@@ -0,0 +1,26 @@
+Integration with Enterprise Systems
+===================================
+
+When using Pyramid within an "enterprise" (or an intranet), it is often desirable to
+integrate with existing authentication and authorization (entitlement) systems.
+For example, in Microsoft Network environments, the user database is typically
+maintained in Active Directory. At present, there is no ready-to-use recipe, but we
+are listing places that may be worth looking at for ideas when developing one:
+
+Authentication
+--------------
+
+* `adpasswd project on pypi <http://pypi.python.org/pypi/adpasswd/0.2>`_
+* `Tim Golden's Active Directory Cookbook <http://timgolden.me.uk/python/ad_cookbook.html>`_
+* `python-ad <http://code.google.com/p/python-ad/>`_
+* `python-ldap.org <http://www.python-ldap.org/>`_
+* `python-ntmlm <http://code.google.com/p/python-ntlm/>`_
+* `Blog post on managing AD from Python in Linux <http://marcitland.blogspot.com/2011/02/python-active-directory-linux.html>`_
+
+Authorization
+-------------
+
+* `Microsoft Authorization Manager <http://msdn.microsoft.com/en-us/library/aa480244.aspx>`_
+* `Fundamentals of WCF Security <http://www.code-magazine.com/article.aspx?quickid=0611051>`_
+* `Calling WCF Services from C++ using gSOAP <http://coab.wordpress.com/2009/10/15/calling-wcf-services-from-a-linux-c-client-using-gsoap/>`_
+
View
@@ -1,61 +1,18 @@
Authentication and Authorization
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
.. toctree::
:maxdepth: 1
- user_object
- custom
basic
+ custom
+ user_object
wiki2_auth
-
-Auth Tutorial
-=============
-
-See Michael Merickel's authentication/authorization tutorial at
-http://michael.merickel.org/projects/pyramid_auth_demo/ with code on Github at
-https://github.com/mmerickel/pyramid_auth_demo.
-
-Pyramid Auth with Akhet and SQLAlchemy
-======================================
-
-Learn how to set up Pyramid authorization using Akhet and SQLAlchemy at
-http://pyramid.chromaticleaves.com/simpleauth/.
-
-Google, Facebook, Twitter, and any OpenID Authentication
-========================================================
-
-See `Wayne Witzel III's blog post
-<http://pieceofpy.com/blog/2011/07/24/pyramid-and-velruse-for-google-authentication/>`_
-about using Velruse and Pyramid together to do Google OAuth authentication.
-
-See Matthew Housden and Chris Davies apex project for any basic and
-openid authentication such as Google, Facebook, Twitter and more at
-https://github.com/cd34/apex.
-
-Integration with Enterprise Systems
-===================================
-
-When using Pyramid within an "enterprise" (or an intranet), it is often desirable to
-integrate with existing authentication and authorization (entitlement) systems.
-For example, in Microsoft Network environments, the user database is typically
-maintained in Active Directory. At present, there is no ready-to-use recipe, but we
-are listing places that may be worth looking at for ideas when developing one:
-
-Authentication
---------------
-
-* `adpasswd project on pypi <http://pypi.python.org/pypi/adpasswd/0.2>`_
-* `Tim Golden's Active Directory Cookbook <http://timgolden.me.uk/python/ad_cookbook.html>`_
-* `python-ad <http://code.google.com/p/python-ad/>`_
-* `python-ldap.org <http://www.python-ldap.org/>`_
-* `python-ntmlm <http://code.google.com/p/python-ntlm/>`_
-* `Blog post on managing AD from Python in Linux <http://marcitland.blogspot.com/2011/02/python-active-directory-linux.html>`_
-
-Authorization
--------------
-
-* `Microsoft Authorization Manager <http://msdn.microsoft.com/en-us/library/aa480244.aspx>`_
-* `Fundamentals of WCF Security <http://www.code-magazine.com/article.aspx?quickid=0611051>`_
-* `Calling WCF Services from C++ using gSOAP <http://coab.wordpress.com/2009/10/15/calling-wcf-services-from-a-linux-c-client-using-gsoap/>`_
+ auth_tutorial
+ akhet_sqlalchemy
+ open_id_auth
+ enterprise
+
+For basic information on authentication and authorization, see the
+`security <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/security.html>`_
+section of the Pyramid documentation.
View
@@ -0,0 +1,11 @@
+Google, Facebook, Twitter, and any OpenID Authentication
+========================================================
+
+See `Wayne Witzel III's blog post
+<http://pieceofpy.com/blog/2011/07/24/pyramid-and-velruse-for-google-authentication/>`_
+about using Velruse and Pyramid together to do Google OAuth authentication.
+
+See Matthew Housden and Chris Davies apex project for any basic and
+openid authentication such as Google, Facebook, Twitter and more at
+https://github.com/cd34/apex.
+
@@ -3,6 +3,14 @@ Configuration
.. toctree::
:maxdepth: 2
-
+
whirlwind_tour
django_settings
+
+For more information on configuration see the following sections of the Pyramid documentation:
+
+- `basic configuration <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/configuration.html>`_
+- `advanced configuration <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/advconfig.html>`_
+- `configuration introspection <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/introspector.html>`_
+- `extending configuration <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/extconfig.html>`_
+- `PasteDeploy configuration <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/paste.html>`_
@@ -30,7 +30,8 @@ different projects in production with much success, but never verbatim.
What is WSGI?
+++++++++++++
-WSGI is a Python standard dictating the interface between a server and an
+WSGI is a `Python standard <http://www.python.org/dev/peps/pep-0333/>`_
+dictating the interface between a server and an
application. The entry point to your pyramid application is an object
implementing the WSGI interface. Thus, your application can be served by any
server supporting WSGI.
@@ -47,3 +48,5 @@ A short list includes:
+ ``gevent``
+ ``mod_wsgi``
+
+For more information on WSGI, see the `WSGI home <http://wsgi.org>`_
@@ -14,3 +14,5 @@ gevent + long polling
http://michael.merickel.org/2011/6/21/tictactoe-and-long-polling-with-pyramid/
https://github.com/mmerickel/tictactoe
+
+For more information on gevent see the `gevent home page <http://www.gevent.org/>`_
@@ -6,8 +6,8 @@ of traffic. The advantage in deployment is that by using ``paster``, it is not
unlike the basic development environment you're probably using on your local
machine.
-Nginx is a highly optimized HTTP server, very capable of serving static
-content as well as acting as a proxy between other applications and the
+`Nginx <http://wiki.nginx.org/Main>`_ is a highly optimized HTTP server, very capable of serving
+static content as well as acting as a proxy between other applications and the
outside world. As a proxy, it also has good support for basic load balancing
between multiple instances of an application.
View
@@ -21,7 +21,6 @@ It supplements the `main documentation
static_assets/index
templates/index
testing/index
- traversal_in_views
views/index
misc/index
todo
View
@@ -5,3 +5,7 @@ Logging
:maxdepth: 2
sqlalchemy_logger
+
+For more information on logging, see the `Logging
+<http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/logging.html>`_
+section of the Pyramid documentation.
View
@@ -5,4 +5,18 @@ Traversal and URL dispatch
:maxdepth: 2
combining
+ traversal_in_views
traversal_sqlalchemy
+
+For more information on URL dispatch, see the `URL Dispatch
+<http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/urldispatch.html>`_
+section of the Pyramid documentation.
+
+For more information traversal, see the following sections of the Pyramid
+documentation:
+
+- `Hello Traversal <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/hellotraversal.html>`_
+- `Much Ado about Traversal <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/muchadoabouttraversal.html>`_
+- `Traversal <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/traversal.html>`_
+- `Hybrid Dispatching <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/hybrid.html>`_
+- `Virtual Hosting <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/vhosting.html>`_
File renamed without changes.
@@ -5,3 +5,8 @@ Static Assets (Static Files)
:maxdepth: 2
files
+
+
+For more information on static assets, see the `Static Assets
+<http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/assets.html>`_
+section of the Pyramid documentation.
View
@@ -7,3 +7,11 @@ Templates and Renderers
templates
mako_i18n
chameleon_i18n
+
+For more information on Templates and Renderers, see the following sections
+of the Pyramid documentation:
+
+- `Templates <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/templates.html>`_
+- `Renderers <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/renderers.html>`_
+- `Internationalization and Localization
+ <http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/i18n.html>`_
View
@@ -5,3 +5,12 @@ Testing
:maxdepth: 2
testing_post_curl
+
+For more information on testing see the `Testing
+<http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/testing.html>`_
+section of the Pyramid documentation.
+
+For additional information on other testing packages see:
+
+- `WebTest <http://webtest.pythonpaste.org/en/latest/>`_
+- `nose <https://nose.readthedocs.org/en/latest/>`_
View
@@ -62,3 +62,8 @@ TODO
- Outgrowing Pyramid Handlers: http://michael.merickel.org/2011/8/23/outgrowing-pyramid-handlers/
- Incorporate Google Analytics into a Pyramid Application: http://russell.ballestrini.net/incorporate-google-analytics-into-a-pyramid-application/
+
+- Cookbook docs reorg
+
+ - Add reference links to main documentation
+ - Move tutorials/overviews to tutorial project and replace with links
View
@@ -7,3 +7,7 @@ Views
chaining_decorators
params_mapper
+For more information on views, see the `Views
+<http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/views.html>`_
+section of the Pyramid documentation.
+

0 comments on commit d365974

Please sign in to comment.