Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
--+
 Reporter:  pydanny   |Owner:  pydanny
 Type:  Cleanup/optimization  |   Status:  closed
Component:  Documentation |  Version:  1.4
 Severity:  Normal|   Resolution:  fixed
 Keywords:| Triage Stage:  Accepted
Has patch:  1 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+
Changes (by Tim Graham ):

 * status:  new => closed
 * resolution:   => fixed


Comment:

 In [changeset:"07abb7a6b7af2c45be553acf08d85cd2d72057ad"]:
 {{{
 #!CommitTicketReference repository=""
 revision="07abb7a6b7af2c45be553acf08d85cd2d72057ad"
 Fixed #18715 - Refactored tutorial 3. Thank-you Daniel Greenfeld!
 }}}

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
--+
 Reporter:  pydanny   |Owner:  pydanny
 Type:  Cleanup/optimization  |   Status:  new
Component:  Documentation |  Version:  1.4
 Severity:  Normal|   Resolution:
 Keywords:| Triage Stage:  Accepted
Has patch:  1 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+

Comment (by timo):

 Fixed typo and updated per Russ's feedback except for "another option is
 to put a templates directory in your polls app, which will be
 automatically discovered by Django." since #16671 talks about this. I'll a
 note here when committing that.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
--+
 Reporter:  pydanny   |Owner:  pydanny
 Type:  Cleanup/optimization  |   Status:  new
Component:  Documentation |  Version:  1.4
 Severity:  Normal|   Resolution:
 Keywords:| Triage Stage:  Accepted
Has patch:  1 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+

Comment (by carljm):

 This looks really good. Only thing I noticed on a quick skim was that
 there's an occurrence of `HttpReponse` as a typo for `HttpResponse` midway
 through tutorial 3.

 Great work!

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
--+
 Reporter:  pydanny   |Owner:  pydanny
 Type:  Cleanup/optimization  |   Status:  new
Component:  Documentation |  Version:  1.4
 Severity:  Normal|   Resolution:
 Keywords:| Triage Stage:  Accepted
Has patch:  1 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+

Comment (by russellm):

 This is looking really good. A couple of fairly small suggestions:

  * In the discussion about regexes, it says "These are super fast", and
 directs people to the docs on regexes. This gives me two concerns.
 1) it suggests that you need to know all about regexes, when in
 practice, you really only need to know how to capture simple patterns.
 2) it implies that it's a good idea to use the full capabilities of
 regexes -- which isn't correct, given that some regexes can have
 pathologial lookup performance.
It might be worth a qualifier to say that we're only going to touch the
 tip of the iceberg of what regexes can do, and that you probably shouldn't
 rely on the full power of regexes.

  * When it introduces templates, it suggests creating a directory
 "anywhere on the filesystem" and putting it in TEMPLATE_DIRS, "just like
 we did in tutorial 2". It seems to me we're missing an opportunity to say
 two things:
 1) That you can use the same TEMPLATE_DIRS setting from tutorial 2;
 you don't need to create a completely new one for your "app" templates
 2) That another option is to put a templates directory in your polls
 app, which will be automatically discovered by Django.
   My concern here is mostly that "put it anywhere" will lead to people
 putting it genuinely anywhere. Part of the role of the tutorial is to
 establish best practices, so "in the project directory" is good advice to
 be giving here. Plus, if we leave people to their own devices, they're
 going to find some interesting locations -- and some places (like the HTTP
 server doc root) are potentially a bad idea.

  * 404.html and 500.html suggest that you should create them, but doesn't
 (explicitly) say you should put content in them. If I was going to guess
 how the tutorial would fail, it will be because "I created an empty
 500.html, and now my browser is showing nothing". Suggesting that people
 put in some dummy content ("Page not found"/"Something went wrong") seems
 appropriate to me.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
--+
 Reporter:  pydanny   |Owner:  pydanny
 Type:  Cleanup/optimization  |   Status:  new
Component:  Documentation |  Version:  1.4
 Severity:  Normal|   Resolution:
 Keywords:| Triage Stage:  Accepted
Has patch:  1 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+

Comment (by timo):

 Here is a link to the updated tutorial 3 & 4 if you would like to review
 without downloading the patch and building the docs yourself.

 http://techytim.com/django/tutorial03/intro/tutorial03.html

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
--+
 Reporter:  pydanny   |Owner:  pydanny
 Type:  Cleanup/optimization  |   Status:  new
Component:  Documentation |  Version:  1.4
 Severity:  Normal|   Resolution:
 Keywords:| Triage Stage:  Accepted
Has patch:  1 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+

Comment (by timo):

 I made edits based on my suggestions:

 -Omitted regex and view kwargs when defining URLs
 -Moved "What is a URLconf?" higher up
 -Removed use of absolute_import (let's make that a separate ticket and
 convert the entire tutorial if it's something we want to do)
 -Modified bits of tutorial 4 that are affected by this (took a quick shot
 at it; needs to be double checked and tested).

 I plan to give this another look tomorrow and post the built HTML so we
 can ask people to give it a try before committing.

 Thank-you for the great work Danny -- the old tutorial really does seem
 awkward in some spots after running through this version!

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
--+
 Reporter:  pydanny   |Owner:  pydanny
 Type:  Cleanup/optimization  |   Status:  new
Component:  Documentation |  Version:  1.4
 Severity:  Normal|   Resolution:
 Keywords:| Triage Stage:  Accepted
Has patch:  1 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+

Comment (by timo):

 Would you like to make some tweaks based on my comments (or let me know if
 you disagree with them)?

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
--+
 Reporter:  pydanny   |Owner:  pydanny
 Type:  Cleanup/optimization  |   Status:  new
Component:  Documentation |  Version:  1.4
 Severity:  Normal|   Resolution:
 Keywords:| Triage Stage:  Accepted
Has patch:  1 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+

Comment (by pydanny):

 What should I do to move this ticket forward?

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
--+
 Reporter:  pydanny   |Owner:  pydanny
 Type:  Cleanup/optimization  |   Status:  new
Component:  Documentation |  Version:  1.4
 Severity:  Normal|   Resolution:
 Keywords:| Triage Stage:  Accepted
Has patch:  1 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+
Changes (by timo):

 * cc: timograham@… (added)


Comment:

 Agreed with Aymeric's thoughts on URLs.  Although I can see how it leads
 naturally into the detailed sections that follow, I've never used or seen
 such a verbose syntax.  Maybe introduce that once and then explain that we
 don't need to include the keywords and change it to the more compact: {{{
 url(r'^$', views.index, name='index') }}}

 The note "What is a URLconf?" seems a bit out of place following 4
 paragraphs of detailed explanations. Move it higher and not necessarily in
 an admonition box?

 I'm unfamiliar with absolute_import, but it seems out of place with the
 rest of the tutorial.  May be better to convert the entire thing to use it
 either now or as a separate ticket?

 The patch leaves the old "Removing hardcoded URLs in templates" at the
 very bottom of the file.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
--+
 Reporter:  pydanny   |Owner:  pydanny
 Type:  Cleanup/optimization  |   Status:  new
Component:  Documentation |  Version:  1.4
 Severity:  Normal|   Resolution:
 Keywords:| Triage Stage:  Accepted
Has patch:  1 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+
Changes (by aaugustin):

 * owner:  aaugustin => pydanny


Comment:

 Restoring ticket ownership after my review.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
-+-
 Reporter:  pydanny  |Owner:  aaugustin
 Type:   |   Status:  new
  Cleanup/optimization   |  Version:  1.4
Component:  Documentation|   Resolution:
 Severity:  Normal   | Triage Stage:  Accepted
 Keywords:   |  Needs documentation:  0
Has patch:  1|  Patch needs improvement:  0
  Needs tests:  0|UI/UX:  0
Easy pickings:  0|
-+-

Comment (by aaugustin):

 I'm not comfortable with the very verbose way of defining urls. Is this
 the canonical style we intend to promote? It's fine to explain the `url()`
 function in detail but in my opinion we should quickly show the more
 concise and common syntax, especially since it appears several times
 further down the document.

 Some sentences reference examples further down the document (I had written
 down the list but I managed to lost it, sorry -- me or someone else will
 have to proof-read the whole document again).

 Otherwise this looks very good to me.

 I've improved the markup and added some information (positional vs.
 keyword arguments, 500.html template, etc. -- I also lost that list). I'm
 attaching a consolidated patch that reflect the state after my edits.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
-+-
 Reporter:  pydanny  |Owner:  aaugustin
 Type:   |   Status:  new
  Cleanup/optimization   |  Version:  1.4
Component:  Documentation|   Resolution:
 Severity:  Normal   | Triage Stage:  Accepted
 Keywords:   |  Needs documentation:  0
Has patch:  1|  Patch needs improvement:  0
  Needs tests:  0|UI/UX:  0
Easy pickings:  0|
-+-
Changes (by aaugustin):

 * owner:  pydanny => aaugustin


-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
--+
 Reporter:  pydanny   |Owner:  pydanny
 Type:  Cleanup/optimization  |   Status:  new
Component:  Documentation |  Version:  1.4
 Severity:  Normal|   Resolution:
 Keywords:| Triage Stage:  Accepted
Has patch:  1 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+
Changes (by timo):

 * has_patch:  0 => 1
 * stage:  Unreviewed => Accepted


-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
-+-
 Reporter:  pydanny  |Owner:  pydanny
 Type:   |   Status:  new
  Cleanup/optimization   |  Version:  1.4
Component:  Documentation|   Resolution:
 Severity:  Normal   | Triage Stage:
 Keywords:   |  Unreviewed
Has patch:  0|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-

Comment (by pydanny):

 Pull request is on Github https://github.com/django/django/pull/248/

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
-+-
 Reporter:  pydanny  |Owner:  pydanny
 Type:   |   Status:  new
  Cleanup/optimization   |  Version:  1.4
Component:  Documentation|   Resolution:
 Severity:  Normal   | Triage Stage:
 Keywords:   |  Unreviewed
Has patch:  0|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-

Comment (by pydanny):

 Actually, this ticket covers:

 * Changing the order of instructions. Views and Urls are 'tightly coupled'
 in the code and should be so in the tutorial.
 * Views and Templates should be taught not via throwing errors and then
 fixing them.
 * Good practices on URLconf are taught from the beginner per Jessica
 McKellar. For example, we begin with polls/urls.py in place rather than
 adding them at the end.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
-+-
 Reporter:  pydanny  |Owner:  pydanny
 Type:   |   Status:  new
  Cleanup/optimization   |  Version:  1.4
Component:  Documentation|   Resolution:
 Severity:  Normal   | Triage Stage:
 Keywords:   |  Unreviewed
Has patch:  0|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-
Changes (by pydanny):

 * status:  assigned => new
 * owner:  anonymous => pydanny


-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
-+-
 Reporter:  pydanny  |Owner:  anonymous
 Type:   |   Status:  assigned
  Cleanup/optimization   |  Version:  1.4
Component:  Documentation|   Resolution:
 Severity:  Normal   | Triage Stage:
 Keywords:   |  Unreviewed
Has patch:  0|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-
Changes (by pydanny):

 * status:  new => assigned
 * needs_better_patch:   => 0
 * owner:  nobody => anonymous
 * needs_tests:   => 0
 * needs_docs:   => 0


-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

[Django] #18715: Tutorial Page 3 Refactor

[Django]

#18715: Tutorial Page 3 Refactor
--+
 Reporter:  pydanny   |  Owner:  nobody
 Type:  Cleanup/optimization  | Status:  new
Component:  Documentation |Version:  1.4
 Severity:  Normal|   Keywords:
 Triage Stage:  Unreviewed|  Has patch:  0
Easy pickings:  0 |  UI/UX:  0
--+
 * URL definitions
 * Text cleanup
 * Implementation of Class based views

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.