Changes between Version 2 and Version 3 of TutorialImprovementSprint

Timestamp:

Aug 19, 2012, 9:21:50 PM (12 years ago)

Author:

stumbles

Comment:

Transcribe whiteboard images.

TutorialImprovementSprint

@@ -26 +26 @@
 === Brainstorming whiteboards ===
 
-Here are some pics of whiteboards we used for brainstorming areas for improvement:
-  http://imgur.com/a/GeHDI
+Installing Django is under-documented by the tutorial; eg. virtualenv
 
-(Reader, please transcribe these into text here if you have time; the images may die some day.)
+We set users up for failure because we don't explain that migrations are important.
+
+We make the question of deployment confusing and opaque.
+
+We can provide "hints" that the user can optionally show/hide if they want more background.
+
+3 groups to address:
+
+1. Total beginners
+2. People coming from other frameworks
+3.
+
+Parametrize the tutorial?
+
+* JS show/hide parts
+* check off boxes at beginning about your level of experience
+
+Google App Engine? Beginners very often come to Django thinking GAE will be the easiest way to deploy, but that's incorrect. Why we need to also point to Heroku (and other?) options.
+
+Projects suggestions:
+
+* Redesign docs homepage:
+
+  * break down into topics
+  * make it easier to find things
+
+* Django explained to rails developers
+
+* No more Polls
+
+* class based views!
+
+Lots of people still use The Django Book
+
+Test runner confusion with creating/deleting databases
+
+Not enough info on testing views in particular as opposed to general unit-testing. Maybe part of testing reference docs?
+
+Other tutorials need to be linked, eg. how to use pip/virtualenv
+
+Suggested types of tools, eg. you probably should use a migration tool
+
+List of links to step 5
+
+Different versions by different vendors?
+
+But also why. Why even deploy your project. What does that mean?
+
+Python sucks on Windows.
+
+People sometimes don't know how to use the command line.
+
+"Where's my button?"
+
+Need to point to good outside tutorials for this.
+
+Encourage them to use virtualbox? But that turns newbies off.
+
+What about when people get through the tutorial and come out not knowing about platform-specific basics, like Windows env vars?
+
+Tutorial page 1
+
+Settings file
+
+At least have user change timezone and provide a link to the timezones used.
+
+What? There's an FAQ? Maybe update/integrate it somehow.
+
+Need best practises.
+
+* What is a project? an app?
+* What about that apps/ folder practise?
+* What about cross-app situations?
+* Maybe make this part 5?
+
+Coming from Rails:
+
+* View and controller confusion
+* Non-textbook MVC
+* Template == Views??
+* Even for beginners who hear about "MVC", a high-level/big picture would be useful
+* Hints on the side for learning more Python, or inline boxes
+
+(Original whiteboard images: http://imgur.com/a/GeHDI)