Changes between Initial Version and Version 1 of Ticket #28582


Ignore:
Timestamp:
Sep 10, 2017, 9:32:32 AM (7 years ago)
Author:
ImmaSix
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #28582 – Description

    initial v1  
    11working at write the docs conference with Daniele Procida. Work in progress, will add more notes here.
    22
    3 * tutorial 01: changing the port block explanation not necessary - beginning users can skip this,
    4 *
     3* tutorial 01: "changing the port" block explanation not necessary - beginning users can skip this,
     4* tutorial 01: "Projects vs. apps" block explanation not necessary.
     5* tutorial 01: mysite/urls.py code snippets: the two code snippets are different from each other. The second adds not only the `include` as described in the tutorials, but also adds more lines that are not explained.
     6* tutorial 01: explanation for `include()` a bit too detailed. A part of it can move to the `include()` reference if it isn't already there.
     7* tutorial 01: a bit of explanation about the 'url()'  arguments is well-suited. Some remarks:
     8
     9  1. explanation about performance of regular expressions is not necessary.
     10  2. kwargs and name are not used in the example and are optional: can probably be removed.
     11
     12* tutorial 02: for a tutorial, it is ok to stick to the SQLite database. Any information about settings for other databases can be moved away. If it is important to set the database correctly this early in the project, I'd suggest to make a how-to and create a link to it.
     13* tutorial 02: The content of the **philosophy** block might be moved to the main text, so that the main text is not interrupted by the block. Explaining why we create a model is important enough. If the explanation can be a bit shorter, that would be great.
     14* tutorial 02: block bypassing manage.py is not necessary.
     15* tutorial 02: the line {{{@python_2_unicode_compatible  # only if you need to support Python 2}}} comes a bit out of the blue. How important is this line?
Back to Top