#31385 closed Cleanup/optimization (fixed)
Improve wording of starting a new app in tutorial 1.
Reported by: | Kevin Crum | Owned by: | Victor Moura |
---|---|---|---|
Component: | Documentation | Version: | 3.0 |
Severity: | Normal | Keywords: | Tutorial Ambiguity |
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
In tutorial 01 (https://docs.djangoproject.com/en/3.0/intro/tutorial01/) after running start project the tutorial tells the user to add an app to the project. The tutorial uses plain English to state
Your apps can live anywhere on your Python path. In this tutorial, we’ll create our poll app right next to your manage.py file so that it can be imported as its own top-level module, rather than a submodule of mysite.
The problem lies with the use of 'right next to'.
While the tutorial does say 'top-level' that nuance can be missed by many. The tutorial also shows the directory tree of the project before adding the app and it is not entirely clear what directory one is in when they run the add app command.
I feel that if we have the language (eg the word directory) to describe where the command should be run and where the files should be this can help remove ambiguity that lives in a crucial step of the tutorial.
Change History (5)
comment:1 by , 5 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:2 by , 5 years ago
Component: | Uncategorized → Documentation |
---|
comment:3 by , 5 years ago
Has patch: | set |
---|---|
Summary: | Suggestion to remove ambiguity in tutorial01 in the use of the phrase 'next to' perhaps change to 'in same directory' → Improve wording of starting a new app in tutorial 1. |
Triage Stage: | Unreviewed → Accepted |
Type: | Uncategorized → Cleanup/optimization |
This sounds a really minor to me, but let's have it.
I agree that the term "in the same directory" or "in the same folder" would be more clear