#35502 closed Cleanup/optimization (fixed)
In the tutorial we have two mysite directories, and we often see users confused by that.
Reported by: | Meta Petric | Owned by: | Meta Petric |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | tutorial |
Cc: | Triage Stage: | Ready for checkin | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description (last modified by )
The tutorial instructs you to make a mysite
directory and in that directory make another one with the same name. We could resolve this confusion by changing the start project
command from : django-admin startproject mysite
to django-admin startproject mysite djangotutorial
. That way it becomes clear to which directory the tutorial is referring to.
There was a ticket #22042 (confused in tutorial 03 about location of mysite/urls.py) that has already been closed, but maybe this solution will be beneficial.
Reference to the tutorial: https://docs.djangoproject.com/en/dev/intro/tutorial01/#creating-a-project
Change History (19)
comment:1 by , 7 months ago
Description: | modified (diff) |
---|---|
Summary: | We have two mysite directories, and we often see users confused by that. → In the tutorial we have two mysite directories, and we often see users confused by that. |
comment:2 by , 6 months ago
Easy pickings: | set |
---|---|
Triage Stage: | Unreviewed → Accepted |
Type: | Uncategorized → Cleanup/optimization |
comment:3 by , 6 months ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:5 by , 6 months ago
Has patch: | set |
---|
comment:6 by , 6 months ago
Hi folks, I have submitted a pull request to address this issue. Here is the link to the PR: PR.
comment:7 by , 6 months ago
Patch needs improvement: | set |
---|---|
Resolution: | → wontfix |
Status: | assigned → closed |
Having read through the changes, I am no longer convinced this is the best way forward as django-admin startproject mysite
is the simplist version of running the startproject
command and having this documented in the intro tutorial has some benefits. This makes me think that a wider discussion is needed. If you wish to progress this change, please discuss it on the forum also to confirm where exactly beginners get confused as maybe this isn't the right way to fix it.
tabvia please note that you your PR is missing some file header updates for the code snippets in the tutorial.
comment:8 by , 6 months ago
I've been investigating other resources to check what they do, and I think there is enough variation/confusion that we should take a stance and improve our tutorial. Some links showing how startproject
is used:
- Your First Steps With Django: Set Up a Django Project uses
django-admin startproject setup
but it has a long and arguably confusing/distracting note about why the duplicatedsetup
folder - Get Started With Django: Build a Portfolio App uses
django-admin startproject personal_portfolio .
but it needs to clarify that Don’t forget to add the dot (.) at the end of the command above. since it can be easily missed. - Django Girls Tutorial: Your first Django project! uses
django-admin startproject mysite .
and it also needs to clarify how crucial the dot is.
I'll go back to the first PR created for this issue and review with this in mind, will post updates afterwards.
comment:9 by , 5 months ago
Description: | modified (diff) |
---|---|
Resolution: | wontfix |
Status: | closed → new |
After some further thinking, and considering all the discussion that took place during the Improving the Intro Documentation workshop at DjangoCon Europe, I think that this ticket is worth pursuing. I'm re-opening to iterate over the PR that Meta submitted.
comment:10 by , 5 months ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:11 by , 5 months ago
Patch needs improvement: | unset |
---|---|
Triage Stage: | Accepted → Ready for checkin |
comment:12 by , 4 months ago
Patch needs improvement: | set |
---|---|
Triage Stage: | Ready for checkin → Accepted |
comment:13 by , 3 months ago
Owner: | changed from | to
---|
comment:14 by , 3 months ago
Owner: | changed from | to
---|
Hello Sahil, this ticket is still active and owned by Meta, we still need to provide another round of reviews.
comment:15 by , 2 months ago
Easy pickings: | unset |
---|---|
Patch needs improvement: | unset |
Triage Stage: | Accepted → Ready for checkin |
Thank you for this Meta, I think this is a good idea 👍