search

DjangoGirls / tutorial

This is a tutorial we are using for Django Girls workshops
http://tutorial.djangogirls.org/
Other
1.53k stars 1.86k forks source link

Restructure tutorial #1777

Open ekohl opened 1 year ago

ekohl commented 1 year ago

I've been thinking about this for a long time, but I'm wondering how others think.

The main problem I see is that it takes a long time before you get something visible. I'd suggest to restructure it a bit so there are more intermediate results. I'd propose the following (keeping the start the same):

Now the reader has a basic static blog. One option is to add CSS. I've noticed that most of my mentees like that, but I'm a bit worried that then the reader won't even get to the Django parts. So I'd suggest to then make it dynamic.

Now there is a working blog, but it's not very nice. So we're going to fix that.

Now there's a solid base. Here it turns into adding additional functionality.

Any thoughts on this?

das-g commented 1 year ago

Interesting idea. Getting something visible early is certainly important for motivation.

Because a one-day workshop is often not sufficient to go through the whole tutorial, it's kinda important that the first "Deploy!" chapter comes early, as that's a crucial step to take together (and might need some hand-holding), after which mentees can more easily continue the tutorial even after the workshop for themselves at home, if they choose to.

With your suggestion, there would be one chapter more before the "Deploy!" chapter, but as not all chapters are equally long (and not equally difficult or tricky), it might maybe not actually take longer to get there.

das-g commented 1 year ago

How are the current interdependencies between the affected chapters? Could we just re-arrange them in the SUMMARY.md files (thus also keeping the translations mostly intact) or would some of them need to be partially rewritten?

ekohl commented 1 year ago

Interesting idea. Getting something visible early is certainly important for motivation.

That motivation was indeed my reason.

Because a one-day workshop is often not sufficient to go through the whole tutorial, it's kinda important that the first "Deploy!" chapter comes early, as that's a crucial step to take together (and might need some hand-holding), after which mentees can more easily continue the tutorial even after the workshop for themselves at home, if they choose to.

Based on the difficulty I think they could go through it relatively quickly that it's not a big concern. What it may affect is their energy. The Django bits are harder so they may struggle more at the end of the day.

How are the current interdependencies between the affected chapters? Could we just re-arrange them in the SUMMARY.md files (thus also keeping the translations mostly intact) or would some of them need to be partially rewritten?

From a quick look I think we do need to move some paragraphs around, but I haven't done a thorough investigation.

PARKER-X commented 1 year ago

@das-g How can i run this tutorial on vs code any command.

das-g commented 1 year ago

@PARKER-X What do you mean? And how is that related to this issue here (restructuring the tutorial)?

If you are going through the tutorial as a participant in a Django Girls workshop event, ask your coach. If you need help or support while going through the tutorial on your own, please use the Gitter chat room. If there's something wrong or to be improved in the tutorial itself, please file a separate issue unless there already is one about the exact problem.

PARKER-X commented 1 year ago

Sorry it is nor related to this. I forked this project and i want to run this project on my desktop so how can i run any command?

das-g commented 1 year ago

@PARKER-X If it's not related to this issue, please file a new issue or ask in the Gitter chat room.

amakarudze commented 1 year ago

@ekohl thanks for the suggestion. This is a great idea. I have created a branch for this and related issue #1792 restructure-tutorial and will add a guide for this for to the Readme. I have some bandwidth and can get this started. I will also pin these two issues once I have added a guide for this change.