Many documentation enhancements

README.rst

@@ -9,95 +9,17 @@ Introduction
 
 Django Packages solves the problem in the Django community of being able to easily identify good apps, frameworks, and packages. Ever want to know which is the most popular or well supported Django blog, content management system, or api tool? Django Packages solves that problem for you!
 
-A Django package is anything that is involved in the Django ecosphere that can be stored on a repository such as Github or Bitbucket. If it can be stored in Pypi thats even better!
+A Django package is anything that is involved in the Django ecosphere that can be stored on a repository such as Github or Bitbucket. If it can be stored in PyPI thats even better!
 
 The Site
 --------
 
-The site is live and functional at http://www.djangopackages.com.  
+The site is live and functional at http://www.djangopackages.com.
 
-Grids!
-~~~~~~
-
-Grids let you compare Django packages to each other. A grid comes with a number of default items compared, but you can add more features in order to get a more specific comparison.
-
-We are trying out Django Packages without the traditional tagging system, because we think that grids give us a lot more specificity.
-
-Categories of Django Packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The fixtures provide four categories: apps, frameworks, projects, and utilities. 
-
-Google Project Hosting, Launchpad, and Sourceforge are not fully supported!
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Not yet. Django Packages was cooked up during Django Dash 2010. We wanted to keep the scope of our work reasonable. We'll try and include those sites in the future. We also want to include other package repo systems over time. As for what we support:
-
- * Django Packages does support Github and Bitbucket.
- * Launchpad is next.
- * Sourceforge comes after Launchpad
- * Google Project Hosting may not happen because of a lack of a formal API and not much desire to screen scrape their arcane browser interface.
-
-Installation
-============
-
-.. parsed-literal::
-
-    cd <installation-directory>
-    virtualenv env-djangopackages
-    source env-djangopackages/bin/activate
-    git clone git://github.com/djangopackages/djangopackages.git djangopackages
-    cd djangopackages
-    cp backup.db dev.db
-    cp local_settings.py.example local_settings.py
-    pip install -r requirements/project.txt
-
-Remove the existing pinax & uni_form symlinks.  Add symlinks to the correct pinax and uni_form media directories::
-
-    cd media
-    rm pinax
-    rm uni_form
-    ln -s ../../env-djangopackages/lib/python2.6/site-packages/pinax/media/default/pinax/ pinax
-    ln -s ../../env-djangopackages/lib/python2.6/site-packages/uni_form/media/uni_form/ uni_form
-
-Starting the development server
-===============================
-
-Change your local_settings.py file to point to dev.db then do::
-
-    python manage.py runserver
-
-Create a Django superuser for yourself
-======================================
-
-Replace joe with your username/email::
-
-    python manage.py createsuperuser --username=joe [email protected]
-
-Updating Packages
-=================
-
-You can update all the packages with the following command::
-
-    python manage.py package_updater
-    
-PyPI Issues
-===========
-
-You may ask why the PyPI code is a bit odd in places. PyPI is an organically grown project and uses its own custom designed framework rather than the dominant frameworks that existed during its inception (these being Pylons, Django, TurboGears, and web.py). Because of this you get things like the API having in its package_releases() method an explicit license field that has been replaced by the less explicit list column in the very generic classifiers field. So we have to parse things like this to get Django's license::
-
-    ['Development Status :: 5 - Production/Stable', 'Environment :: Web Environment',
-    'Framework :: Django', 'Intended Audience :: Developers', 'License :: OSI Approved
-    :: BSD License', 'Operating System :: OS Independent', 'Programming Language ::  
-    Python', 'Topic :: Internet :: WWW/HTTP', 'Topic :: Internet :: WWW/HTTP :: 
-    Dynamic Content', 'Topic :: Internet :: WWW/HTTP :: WSGI', 'Topic :: Software
-    Development :: Libraries :: Application Frameworks', 'Topic :: Software
-    Development :: Libraries :: Python Modules']
-    
-The specification is here and this part of it just makes no sense to me::
-
-    http://docs.python.org/distutils/setupscript.html#additional-meta-data
+The Documentation
+-----------------
 
+The documentation is hosted at http://django-packages.rtfd.org
 
 Credits
 =======

docs/contributors.rst

@@ -1,11 +1,31 @@
-Contributors
-============
+Project Leads
+=============
+
+* Audrey Roy <[email protected]>
+* Daniel Greenfeld <[email protected]>
+
+Direct Contributors
+===================
+
 * Adam Saegebarth
+* Andrii Kurinny
 * Brian Ball
-* James Pacilel
+* Bryan Weingarten
+* Eric Spunagle
+* Gisle Aas
+* James Pacileo
 * James Punteney
+* Jim Allman
 * John M. Camara
 * Jonas Obrist
-* Noah Kantrowitz
+* jrothenbuhler
+* Nate Aune
+* Nolan Bruabker
+* Preston Holmes
 * Szilveszter Farkas
-* Taavi Taijala
+* Taavi Taijala
+
+Other Contributors
+==================
+
+* The entire Python community for providing us the tools we needed to build this thing.

docs/index.rst

@@ -16,10 +16,19 @@ Contents:
    updating
    pypi_issues
    license
-   leads
    contributors
+   contributing_to_djangopackages
+   repo_handlers   
    credits
-
+
+================================
+Contributing to Django Packages
+================================
+
+#. Follow the installation instructions!
+#. Fork and branch on github before submitting a pull request
+#. Tests and additions to the docs greatly increases the chances of your pull request being accepted.
+#. Any layout changes must work in Chrome, Safari, Firefox and IE8 and IE9. 
 
 Indices and tables
 ==================

docs/install.rst

@@ -8,18 +8,35 @@ Installation
     source env-djangopackages/bin/activate
     git clone git://github.com/djangopackages/djangopackages.git djangopackages
     cd djangopackages
+    cp backup.db dev.db
+    cp local_settings.py.example local_settings.py
     pip install -r requirements/project.txt
 
-In production add symlinks to the pinax and uni_form media directories::
+Remove the existing pinax & uni_form symlinks.  Add symlinks to the correct pinax and uni_form media directories::
 
     cd media
+    rm pinax
+    rm uni_form
     ln -s ../../env-djangopackages/lib/python2.6/site-packages/pinax/media/default/pinax/ pinax
     ln -s ../../env-djangopackages/lib/python2.6/site-packages/uni_form/media/uni_form/ uni_form
 
-
 Starting the development server
 ===============================
 
-Change your local_settings.py file to point to prod.db then do::
+Change your local_settings.py file to point to dev.db then do::
 
     python manage.py runserver
+
+Create a Django superuser for yourself
+======================================
+
+Replace joe with your username/email::
+
+    python manage.py createsuperuser --username=joe [email protected]
+
+Updating Packages
+=================
+
+You can update all the packages with the following command::
+
+    python manage.py package_updater

docs/introduction.rst

@@ -22,12 +22,11 @@ Categories of Django Packages
 
 The fixtures provide four categories: apps, frameworks, projects, and utilities.
 
-Google Project Hosting, Launchpad, and Sourceforge are not fully supported!
+Google Project Hosting and Sourceforge are not fully supported!
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Not yet. Django Packages was cooked up during Django Dash 2010. We wanted to keep the scope of our work reasonable. We'll try and include those sites in the future. We also want to include other package repo systems over time. As for what we support:
 
- * Django Packages does support Github and Bitbucket.
- * Launchpad is next.
- * Sourceforge comes after Launchpad
+ * Django Packages does support Github and Bitbucket and Launchpad.
+ * Sourceforge needs some tweaking but is otherwise it is done.
  * Google Project Hosting may not happen because of a lack of a formal API and not much desire to screen scrape their arcane browser interface.