Code

Changes between Version 11 and Version 12 of DocSprint12Apr


Ignore:
Timestamp:
04/12/08 20:51:42 (6 years ago)
Author:
jacob
Comment:

added todo

Legend:

Unmodified
Added
Removed
Modified
  • DocSprint12Apr

    v11 v12  
    1 == Documentation sprint, April 12 - 13, 2008 == 
     1= Documentation sprint, April 12 - 13, 2008 = 
    22 
    33We're having a mini-sprint to refactor the documentation this weekend. If you want to help out, join us in #django-sprint. 
    44 
    5 === Who's doing what === 
     5== TODO == 
     6 
     7Well, a lot. See [http://tinyurl.com/68k7cb the notes on contributing to the docsprint]. However, here are some specific things that can be done ''now'' (i.e. aren't dependent on other folks work: 
     8 
     9 * Replace all images ({{{.. image::}}} and {{{.. figure::}}} directives) with local image files -- right now they use absolute URLs to Django's media server. Images should be put in in {{{_static}}} directory next to the document they're used in. For an example, see {{{internals/contributing.txt}}} and the associated {{{internals/_static}}} directory. 
     10 * Add correct Sphinx markup to {{{intro/}}} directory. 
     11 * Write {{{intro/install.txt}}}. It should be based on {{{topics/install}}}, but much much simpler -- geared towards folks just getting started. Python 2.5, sqlite should be the focus. 
     12 * Finish applying {{{django-admin}}} and {{{django-admin-option}}} markup in {{{ref/django-admin.txt}}}. 
     13 * ('''HUGE'''): break up model documentation (currently all in {{{topics/db/models}}} and {{{ref/models/querysets}}} into all the various outlined documents in {{{ref/models}}} and {{{topics/db}}}. 
     14 * ('''QUITE LARGE'''): break up forms documentation from {{{topics/forms/index}}} into the outlined content in {{{topics/forms}}} and {{{ref/forms}}}. 
     15 * Fix up generic views: adapt Chapter 9 of the Django Book (consider this TODO item my permission and license) into {{{topics/generic-views}}}; remove the intro material from {{{ref/generic-views}}} and just leave the overall reference. 
     16 * Add [http://sphinx.pocoo.org/markup/para.html#glossary glossary] directives for "important" terms. A very small starting list can be found [http://www.djangoproject.com/documentation/contributing/#commonly-used-terms in the contributing documentation], but there's many more candidates for glossary. 
     17 * Start looking at the generated index (look in {{{_build/html/genindex.html}}} after running a build) and improving it by adding [http://sphinx.pocoo.org/markup/para.html#index-generating-markup index directives] where appropriate. 
     18 
     19If you choose to do any of these items, remove it from above and add your name/IRC handle below. 
     20 
     21== Who's doing what == 
    622 
    723Please indicate what you're working on below so that we can easily keep track.