Changes between Version 27 and Version 28 of DocSprint12Apr
- Timestamp:
- Apr 14, 2008, 10:44:50 AM (17 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DocSprint12Apr
v27 v28 5 5 == TODO == 6 6 7 Well, 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:7 Well, a lot. See the checklist below. Also, [http://tinyurl.com/68k7cb the notes on contributing to the docsprint]. Other things worth doing, not in the checklist: 8 8 9 * Add correct Sphinx markup to {{{intro/}}} directory.10 * 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.11 * Finish applying {{{django-admin}}} and {{{django-admin-option}}} markup in {{{ref/django-admin.txt}}}.12 9 * ('''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}}}. 13 10 * ('''QUITE LARGE'''): break up forms documentation from {{{topics/forms/index}}} into the outlined content in {{{topics/forms}}} and {{{ref/forms}}}. … … 15 12 * 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. 16 13 * 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. 17 * Fill in documents missing content (see below).18 14 * Find code blocks and make sure they're [http://sphinx.pocoo.org/markup/code.html syntax highlighted] correctly. 19 15 20 16 If you choose to do any of these items, remove it from above and add your name/IRC handle below. 21 22 Oh, one other thing:23 24 * Add more items to this TODO list.25 17 26 18 == Who's doing what ==