Discussion about first draft of tutorial

olasitarska commented 10 years ago

You can preview tutorial here: http://asendecka.gitbooks.io/djangogirls-tutorial/

We would be super grateful for your feedback, pull requests and advice!

lenarother commented 10 years ago

Hi Ola!

Thanks!

Awesome work:

It feels great to browse through it - good layout, nice features (with green ticks and green line)
I love your pictures of the web.
from reading some random parts: nice writing style - pleasant to read and follow.
do you think, the goal could be more visible (e.g. be placed before introduction)
it's a lot of content. Is everything for the Monday or is some work on the participants required before?

Once more: great job! More comments after more careful reading/coding!

Best, Magdalena Rother

On 07/03/2014 11:12 AM, Ola Sitarska wrote:

You can preview tutorial here: http://asendecka.gitbooks.io/djangogirls-tutorial/

We would be super grateful for your feedback, pull requests and advice!

— Reply to this email directly or view it on GitHub https://github.com/DjangoGirls/tutorial/issues/8.

olasitarska commented 10 years ago

Hi @lenarother

Goal more visible - definitely, I even thought about it for a while but didn't write this down.

A lot of content - we know :( we tried to cut down as much as possible, but that is really the hardest part.

Before workshop we want to have everything installed (Python, pip, virtualenv, postgres) and we will ask girls to read How the Internet works and probably even what is Python + what is Django. Just simple theoretical things at home before the workshop. We didn't remove the text because we think it maybe later useful if they want to get back to the workshop. Or just people who will find this resource on the Internet and basically learn themselves.

Thanks! :heart:

lukaszb commented 10 years ago

Wow,

Nice work! I’ve only scanned through the materials but this looks amazing.

I really like keeping introduction to Python short and simple, showing how to use bootstrap and that whole course should end up with deployment.

From my experience the most difficult parts are setting up the environment quickly and the deployment part. As Python installation is covered decently, at the deployment chapter I miss ssh keys part. I can imagine the concept of ssh keys isn’t easy to grasp by someone who’s new to the programming so we should add some description how to create a keys pair for each platform. I have written description for OSX and it would be cool if someone can prepare similar notes for Windows/Linux. PR is here: https://github.com/DjangoGirls/tutorial/pull/11

bmispelon commented 10 years ago

I read through the tutorial and took down some notes as I went:

Inconsistent usage of ' and ´ in sentences
In django_installation, can we safely assume that python points to the python3 binary?
in starting_django_project, sqlite3 is recommended
in starting_django_project, it's mentionned that sqlite3 is installed with Django but it actually comes with Python directly
in starting_django_project, when running syncdb for the first time we can tell the user that the email address for the superuser is optional
in django_models, why is "mysite" in INSTALLED_APPS?
in html, <i> should be italics, not cursive
in html, should we use <br> instead of <br /> ?
in css ("Configure static files in Django"), we should make it clearer which "mysite" folder we're referring to (the inner or outer one)
in template_extending, shouldn't the file simply be mysite/templates/base.html?
in deploy, the prompts should have the virtualenv prompt shown too
in deploy, we should clarify which "mysite" directory we're talking about (the inner or outer one)
in deploy, we should define what "dynos" are before mentionning them
Inconsistent use of HTML vs. html, url vs. URL, ...
in django_forms, <form method="POST"> should be method="post"

Edit Removed the items tackled in #14

asendecka commented 10 years ago

@bmispelon Thank you! We will apply your remarks soon, but feel free to apply changes by yourself, too :). The secret is, that we did a blog app with Python 2.7.6 ;). And we decided that Python 3.4.1 is a better option when we wrote tutorial. We need to walk through everything once again.

Anyway, it would be much appreciated if someone could walk through the tutorial (I mean: code it with tutorial) and see if we have all bits correct. It is possible that we describe something in an incorrect order or made other mistakes.

bmispelon commented 10 years ago

I have a 2h train ride ahead of me so I'll work on some of the points but I wanted to put this somewhere so I don't forget.

Expect a pull request in a few hours.

asendecka commented 10 years ago

@bmispelon \o/ thank you!

bmispelon commented 10 years ago

I did another start-to-finish read-through, where I also typed in the code and found a few other typos ( #17 ).

I also found several more issues, some more serious than others. Should I just dump the whole list here or is it better to create individual issues?

olasitarska commented 10 years ago

@bmispelon THANK YOU!

I think maybe individual issues will be easier to discuss if needed :)

DjangoGirls / tutorial

Discussion about first draft of tutorial #8