[Django] #23648: Documentation suggestion from new Django student.
Django
-------------------------------+----------------------------------
Reporter: kielhorn | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.7
Severity: Normal | Keywords: tutorial settings.py
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+----------------------------------
I am new to Django. I suggest the following change to the tutorial. I was
confused by the use of the word 'default', which I think should be
removed. Please see below. My confusion led to errors when executing
'python manage.py migrate'
Thanks.
Documentation version: 1.7
Section: Writing your first Django app, part 1
Subsection: Database setup
paragraph-2:
"By default, the configuration uses SQLite."
--- The above line is confusing. It suggests
that by doing nothing to settings.py the
sqlite3 database will be used, when actually
'ENGINE' must be set to django.db.backends.sqlite3
and 'NAME' must be set to something.
My suggested wording for this paragraph is:
" The simplest database to use is SQLite.
If you're new to databases, or you're just interested in
trying Django,
this is the easiest choice. SQLite is included in Python,
so you won't need to install anything else to support your
database.
To specify SQLite, you must edit settings.py and set 'ENGINE'
to
'django.db.backends.sqlite3'. You must also set 'NAME' to
some value,
for example, 'myName'."
--
Ticket URL: <https://code.djangoproject.com/ticket/23648>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: kielhorn | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.7
Keywords: tutorial | Triage Stage:
settings.py | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by collinanderson):
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0
Comment:
Since version 1.6, new projects created by ./manage.py startproject have
ENGINE set to 'django.db.backends.sqlite3' in their settings.py. By doing
nothing to settings.py the sqlite3 database will be used.
--
Ticket URL: <https://code.djangoproject.com/ticket/23648#comment:1>
Django
Reporter: kielhorn | Owner: nobody
Type: Uncategorized | Status: closed
Component: Documentation | Version: 1.7
Severity: Normal | Resolution: invalid
Keywords: tutorial | Triage Stage:
settings.py | Unreviewed
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by bmispelon):
* status: new => closed
* resolution: => invalid
Comment:
Hello and welcome to Django!
As Collin mentionned, starting from the version 1.6 of Django, the
settings file for new projects contains a fully functional setup of sqlite
out of the box.
Therefore I think the documentation is correct so I'm going to mark this
ticket as `invalid`.
If you think we've misunderstood your point, feel free to reopen this
ticket.
Thanks for your insight.
--
Ticket URL: <https://code.djangoproject.com/ticket/23648#comment:2>