Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure tutorial #1777

Open
ekohl opened this issue Nov 22, 2022 · 8 comments
Open

Restructure tutorial #1777

ekohl opened this issue Nov 22, 2022 · 8 comments

Comments

@ekohl
Copy link
Collaborator

ekohl commented Nov 22, 2022

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):

  • Your first Django project!
  • Django URLs
  • Django views – time to create!
  • Introduction to HTML
  • Deploy!

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.

  • Django models
  • Django admin
  • Django ORM (Querysets)
  • Dynamic data in templates
  • Django templates

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

  • CSS – make it pretty
  • Template extending

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

  • Extend your application
  • Django Forms
  • What's next?

Any thoughts on this?

@das-g
Copy link
Member

das-g commented Nov 22, 2022

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
Copy link
Member

das-g commented Nov 22, 2022

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
Copy link
Collaborator Author

ekohl commented Nov 22, 2022

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
Copy link

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

@das-g
Copy link
Member

das-g commented Mar 14, 2023

@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
Copy link

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
Copy link
Member

das-g commented Mar 15, 2023

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

@amakarudze
Copy link
Contributor

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants