Author: jtauber
Date: Sat Sep 20 03:28:48 2008
New Revision: 902
Added:
trunk/docs/external_apps.txt
Modified:
trunk/docs/customization.txt
trunk/docs/dependencies.txt
trunk/docs/deployment.txt
trunk/docs/index.txt
trunk/docs/install.txt
trunk/docs/intro.txt
Log:
added content to stubbed out doc
Modified: trunk/docs/customization.txt
==============================================================================
--- trunk/docs/customization.txt (original)
+++ trunk/docs/customization.txt Sat Sep 20 03:28:48 2008
@@ -1,2 +1,45 @@
Customization
-=============
\ No newline at end of file
+=============
+
+As more sites are built using Pinax, more best practices will emerge, but
for now what we recommend is:
+
+- copy the ``pinax/`` project directory
+- make any necessary changes to your manage.py, .wsgi, etc to reflect this
new directory
+- make necessary changes to the ``settings.py`` and ``urls.py`` files there
+- develop your custom apps there
+- develop your own templates there
+
+Settings You Will (Probably) Want To Override
+---------------------------------------------
+
+- ``DEBUG``
+- ``TEMPLATE_DEBUG``
+- ``LOGGING_OUTPUT_ENABLED``
+- ``ADMINS``
+- ``MANAGERS``
+- ``DATABASE_ENGINE``
+- ``DATABASE_NAME``
+- ``DATABASE_USER``
+- ``DATABASE_PASSWORD``
+- ``DATABASE_HOST``
+- ``DATABASE_PORT``
+- ``TIME_ZONE``
+- ``SECRET_KEY``
+- ``DEFAULT_FROM_EMAIL``
+- ``SERVER_EMAIL``
+- ``MAILER_PAUSE_SEND``
+- ``SEND_BROKEN_LINK_EMAILS``
+- ``EMAIL_HOST``
+- ``EMAIL_PORT``
+- ``EMAIL_HOST_USER``
+- ``EMAIL_HOST_PASSWORD``
+- ``EMAIL_SUBJECT_PREFIX``
+- ``EMAIL_DEBUG``
+- ``CONTACT_EMAIL``
+- ``URCHIN_ID``
+- ``BBAUTH_APP_ID``
+- ``BBAUTH_SHARED_SECRET``
+- ``SITE_NAME``
+
+All but ``MAILER_PAUSE_SEND``, ``CONTACT_EMAIL``, ``URCHIN_ID``,
``BBAUTH_APP_ID``, ``BBAUTH_SHARED_SECRET`` and ``SITE_NAME``
+are just the standard Django settings.
Modified: trunk/docs/dependencies.txt
==============================================================================
--- trunk/docs/dependencies.txt (original)
+++ trunk/docs/dependencies.txt Sat Sep 20 03:28:48 2008
@@ -1,2 +1,4 @@
Dependencies
-============
\ No newline at end of file
+============
+
+This will document what apps use what other apps and what external libs.
Modified: trunk/docs/deployment.txt
==============================================================================
--- trunk/docs/deployment.txt (original)
+++ trunk/docs/deployment.txt Sat Sep 20 03:28:48 2008
@@ -1,2 +1,55 @@
Deployment
-==========
\ No newline at end of file
+==========
+
+In short:
+
+- create a ``localsettings.py`` alongside ``settings.py`` for your
host-specific settings (like database connection, email, etc)
+- if you are using WSGI, create a ``.wsgi`` file that does the necessary
path manipulation
+- mod_python instructions coming...
+- set up ``cron`` job for mailer and asynchronous notifications
+
+Sample WSGI File
+----------------
+
+::
+
+ import sys
+ sys.stdout = sys.stderr
+ import os
+ from os.path import abspath, dirname, join
+ from site import addsitedir
+ path =
addsitedir(abspath(join(dirname(__file__), 'django-hotclub', 'external_libs')),
set())
+ if path: sys.path = list(path) + sys.path
+
+ sys.path.insert(0,
abspath(join(dirname(__file__), 'django-hotclub', 'external_apps')))
+ sys.path.insert(0,
abspath(join(dirname(__file__), 'django-hotclub', 'local_apps')))
+ sys.path.insert(0,
abspath(join(dirname(__file__), 'django-hotclub', 'core_apps')))
+ sys.path.insert(0, abspath(join(dirname(__file__), 'django-hotclub')))
+
+ from django.core.handlers.wsgi import WSGIHandler
+
+ os.environ['DJANGO_SETTINGS_MODULE'] = 'pinax.settings'
+
+ application = WSGIHandler()
+
+Sample cronjob
+--------------
+
+See documentation for django-mailer and django-notification for more
information on this:
+
+::
+
+ * * * * * (cd /path/to/pinax; /usr/local/bin/python2.5 manage.py
send_mail >> /path/to/pinax/cron_mail.log 2>&1)
+ * * * * * (cd /path/to/pinax ; /usr/local/bin/python2.5 manage.py
emit_notices >> /path/to/pinax/emit_notices.log 2>&1)
+
+ 0,20,40 * * * * (cd /path/to/pinax; /usr/local/bin/python2.5 manage.py
retry_deferred >> /path/to/pinax/cron_mail_deferred.log 2>&1)
+
+
+See also
+--------
+
+- `Pinax Setup and Deployment`_ by Greg Newman
+- `Getting Started With Pinax`_ by Eric Holscher
+
+.. _`Pinax Setup and Deployment`:
http://www.20seven.org/journal/2008/09/pinax-setup-and-deploy.html
+.. _`Getting Started With Pinax`:
http://ericholscher.com/blog/2008/sep/18/getting-started-pinax/
Added: trunk/docs/external_apps.txt
==============================================================================
--- (empty file)
+++ trunk/docs/external_apps.txt Sat Sep 20 03:28:48 2008
@@ -0,0 +1,12 @@
+External Apps
+=============
+
+The majority of functionality in Pinax is provided by external, reusable
Django apps.
+
+.. toctree::
+ :maxdepth: 1
+
+ external/emailconfirmation/index
+ external/timezones/index
+ external/threadedcomments/index
+ external/ajax-validation/index
Modified: trunk/docs/index.txt
==============================================================================
--- trunk/docs/index.txt (original)
+++ trunk/docs/index.txt Sat Sep 20 03:28:48 2008
@@ -25,12 +25,9 @@
---------------------------------
.. toctree::
- :maxdepth: 1
-
- external/emailconfirmation/index
- external/timezones/index
- external/threadedcomments/index
- external/ajax-validation/index
+ :maxdepth: 2
+
+ external_apps
Indices and tables
==================
Modified: trunk/docs/install.txt
==============================================================================
--- trunk/docs/install.txt (original)
+++ trunk/docs/install.txt Sat Sep 20 03:28:48 2008
@@ -1,2 +1,47 @@
Installation
-============
\ No newline at end of file
+============
+
+Pinax has not yet had its first formal release so the code is only
available via Subversion:
+
+ svn checkout http://django-hotclub.googlecode.com/svn/trunk/
django-hotclub
+
+(The term *django-hotclub* refers to the reusable Django app project that
spawned Pinax.)
+
+Pinax takes a batteries-included approach so that checkout (which includes
a lot of svn:externals for third-party apps and libraries used) will almost
work out of the box. The one exception is the `Python Imaging Library`
(PIL) which you will have to provide yourself if you want photo support.
+
+Note that if you already have an external app or external library on the
path,
+you don't need to use the one we provide.
+
+Once the checkout is complete, you should be able to cd into pinax/ and
run ./manage.py syncdb and ./manage.py runserver to get
+running immediately.
+
+Directory Structure
+-------------------
+
++---------------------+---------------------------------------------------------------+
+| ``pinax/`` | contains a django project and
templates |
++---------------------+---------------------------------------------------------------+
+| ``external_apps/`` | contains external re-usable apps brought in via
svn:externals |
++---------------------+---------------------------------------------------------------+
+| ``local_apps/`` | contains re-usable apps that aren't yet
externalized |
++---------------------+---------------------------------------------------------------+
+| ``core_apps/`` | contains non re-usable apps specific to pinax
site |
++---------------------+---------------------------------------------------------------+
+| ``external_libs/`` | contains external
libraries |
++---------------------+---------------------------------------------------------------+
+
+
+There is some path manipulation in manage.py to get this all to work.
You'll
+need to do something similar in your wsgi or mod_python configuration. See
`Deployment` for more details.
+
+
+See also
+--------
+
+- `Pinax Setup and Deployment`_ by Greg Newman
+- `Getting Started With Pinax`_ by Eric Holscher
+
+
+.. _`Python Imaging Library`: http://www.pythonware.com/products/pil/
+.. _`Pinax Setup and Deployment`:
http://www.20seven.org/journal/2008/09/pinax-setup-and-deploy.html
+.. _`Getting Started With Pinax`:
http://ericholscher.com/blog/2008/sep/18/getting-started-pinax/
Modified: trunk/docs/intro.txt
==============================================================================
--- trunk/docs/intro.txt (original)
+++ trunk/docs/intro.txt Sat Sep 20 03:28:48 2008
@@ -1,2 +1,45 @@
Introduction
-============
\ No newline at end of file
+============
+
+Pinax is an open-source collection of re-usable apps for the `Django Web
Framework`_.
+
+By integrating numerous reusable Django apps to take care of the things
that many sites have in common, it lets you focus on what makes your site
different.
+
+While our initial development is focused around a social networking site,
Cloud27_, we are also working on number of editions tailored to intranets,
learning management, software project management and more.
+
+Features
+--------
+
+At this stage, there is:
+
+- openid support
+- email verification
+- password management
+- site announcements
+- a notification framework
+- user-to-user messaging
+- friend invitation (both internal and external to the site)
+- a basic twitter clone
+- oembed support
+- gravatar support
+- interest groups (called tribes)
+- projects with basic task and issue management
+- threaded discussions
+- wikis with multiple markup support
+- blogging
+- bookmarks
+- tagging
+- contact import (from vCard, Google or Yahoo)
+- photo management
+
+and much more coming...
+
+History and Background
+----------------------
+
+You can learn more about the history and motivation for Pinax in an
`interview with James Tauber on This Week in Django`_ as well as his `talk
on Pinax at DjangoCon 2008`_.
+
+.. _`Django Web Framework`: http://djangoproject.com/
+.. _`interview with James Tauber on This Week in Django`:
http://blog.michaeltrier.com/2008/6/2/this-week-in-django-24-2008-06-01
+.. _`talk on Pinax at DjangoCon 2008`:
http://www.youtube.com/watch?v=1J91Ownq-7g
+.. _`Cloud27`: http://cloud27.com/
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"pinax-updates" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/pinax-updates?hl=en
-~----------~----~----~----~------~----~------~--~---
