Home Explore Help
Sign In
CityApper
/
django
mirror of https://github.com/django/django
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

Fixed #35502 -- Removed duplication of "mysite" directory name in intro docs.

Reorganized intro docs when explaining `django-admin startproject` to prevent
confusion when using "mysite" as both the top-level directory and the Django
project directory name.

Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>
Co-authored-by: Carlton Gibson <carlton@noumenal.es>
Meta 7 months ago
parent
2e3bc59fd3
commit
d2c74cfb48
6 changed files with 37 additions and 34 deletions
Split View Show Diff Stats
  1. 7 7
      docs/intro/overview.txt
  2. 7 7
      docs/intro/reusable-apps.txt
  3. 17 15
      docs/intro/tutorial01.txt
  4. 1 1
      docs/intro/tutorial05.txt
  5. 4 4
      docs/intro/tutorial07.txt
  6. 1 0
      docs/spelling_wordlist

+ 7 - 7
docs/intro/overview.txt
View File 

@@ -26,7 +26,7 @@ representing your models -- so far, it's been solving many years' worth of
 
 database-schema problems. Here's a quick example:
 
 
 .. code-block:: python
 
-    :caption: ``mysite/news/models.py``
 
+    :caption: ``news/models.py``
 
 
     from django.db import models
 
 
@@ -151,7 +151,7 @@ a website that lets authenticated users add, change and delete objects. The
 
 only step required is to register your model in the admin site:
 
 
 .. code-block:: python
 
-    :caption: ``mysite/news/models.py``
 
+    :caption: ``news/models.py``
 
 
     from django.db import models
 
 
@@ -163,7 +163,7 @@ only step required is to register your model in the admin site:
 
         reporter = models.ForeignKey(Reporter, on_delete=models.CASCADE)
 
 
 .. code-block:: python
 
-    :caption: ``mysite/news/admin.py``
 
+    :caption: ``news/admin.py``
 
 
     from django.contrib import admin
 
 
@@ -195,7 +195,7 @@ Here's what a URLconf might look like for the ``Reporter``/``Article``
 
 example above:
 
 
 .. code-block:: python
 
-    :caption: ``mysite/news/urls.py``
 
+    :caption: ``news/urls.py``
 
 
     from django.urls import path
 
 
@@ -235,7 +235,7 @@ and renders the template with the retrieved data. Here's an example view for
 
 ``year_archive`` from above:
 
 
 .. code-block:: python
 
-    :caption: ``mysite/news/views.py``
 
+    :caption: ``news/views.py``
 
 
     from django.shortcuts import render
 
 
@@ -265,7 +265,7 @@ Let's say the ``news/year_archive.html`` template was found. Here's what that
 
 might look like:
 
 
 .. code-block:: html+django
 
-    :caption: ``mysite/news/templates/news/year_archive.html``
 
+    :caption: ``news/templates/news/year_archive.html``
 
 
     {% extends "base.html" %}
 
 
@@ -306,7 +306,7 @@ Here's what the "base.html" template, including the use of :doc:`static files
 
 </howto/static-files/index>`, might look like:
 
 
 .. code-block:: html+django
 
-    :caption: ``mysite/templates/base.html``
 
+    :caption: ``templates/base.html``
 
 
     {% load static %}
 
     <html>

+ 7 - 7
docs/intro/reusable-apps.txt
View File 

@@ -57,7 +57,7 @@ After the previous tutorials, our project should look like this:
 
 
 .. code-block:: text
 
 
-    mysite/
 
+    djangotutorial/
 
         manage.py
 
         mysite/
 
             __init__.py
 
@@ -90,12 +90,12 @@ After the previous tutorials, our project should look like this:
 
             admin/
 
                 base_site.html
 
 
-You created ``mysite/templates`` in :doc:`Tutorial 7 </intro/tutorial07>`,
 
-and ``polls/templates`` in :doc:`Tutorial 3 </intro/tutorial03>`. Now perhaps
 
-it is clearer why we chose to have separate template directories for the
 
-project and application: everything that is part of the polls application is in
 
-``polls``. It makes the application self-contained and easier to drop into a
 
-new project.
 
+You created ``djangotutorial/templates`` in :doc:`Tutorial 7
 
+</intro/tutorial07>`, and ``polls/templates`` in
 
+:doc:`Tutorial 3 </intro/tutorial03>`. Now perhaps it is clearer why we chose
 
+to have separate template directories for the project and application:
 
+everything that is part of the polls application is in ``polls``. It makes the
 
+application self-contained and easier to drop into a new project.
 
 
 The ``polls`` directory could now be copied into a new Django project and
 
 immediately reused. It's not quite ready to be published though. For that, we

+ 17 - 15
docs/intro/tutorial01.txt
View File 

@@ -48,14 +48,21 @@ including database configuration, Django-specific options and
 
 application-specific settings.
 
 
 From the command line, ``cd`` into a directory where you'd like to store your
 
-code, then run the following command:
 
+code and create a new directory named ``djangotutorial``. (This directory name
 
+doesn't matter to Django; you can rename it to anything you like.)
 
 
 .. console::
 
 
-   $ django-admin startproject mysite
 
+   $ mkdir djangotutorial
 
 
-This will create a ``mysite`` directory in your current directory. If it didn't
 
-work, see :ref:`troubleshooting-django-admin`.
 
+Then, run the following command to bootstrap a new Django project:
 
+
 
+.. console::
 
+
 
+   $ django-admin startproject mysite djangotutorial
 
+
 
+This will create a project called ``mysite`` inside the ``djangotutorial``
 
+directory. If it didn't work, see :ref:`troubleshooting-django-admin`.
 
 
 .. note::
 
 
@@ -68,7 +75,7 @@ Let's look at what :djadmin:`startproject` created:
 
 
 .. code-block:: text
 
 
-    mysite/
 
+    djangotutorial/
 
         manage.py
 
         mysite/
 
             __init__.py
 
@@ -79,14 +86,11 @@ Let's look at what :djadmin:`startproject` created:
 
 
 These files are:
 
 
-* The outer :file:`mysite/` root directory is a container for your project. Its
 
-  name doesn't matter to Django; you can rename it to anything you like.
 
-
 
 * :file:`manage.py`: A command-line utility that lets you interact with this
 
   Django project in various ways. You can read all the details about
 
   :file:`manage.py` in :doc:`/ref/django-admin`.
 
 
-* The inner :file:`mysite/` directory is the actual Python package for your
 
+* :file:`mysite/`: A directory that is the actual Python package for your
 
   project. Its name is the Python package name you'll need to use to import
 
   anything inside it (e.g. ``mysite.urls``).
 
 
@@ -111,8 +115,8 @@ These files are:
 
 The development server
 
 ======================
 
 
-Let's verify your Django project works. Change into the outer :file:`mysite` directory, if
 
-you haven't already, and run the following commands:
 
+Let's verify your Django project works. Change into the :file:`djangotutorial`
 
+directory, if you haven't already, and run the following commands:
 
 
 .. console::
 
 
@@ -182,10 +186,8 @@ rather than creating directories.
 
     configuration and apps for a particular website. A project can contain
 
     multiple apps. An app can be in multiple projects.
 
 
-Your apps can live anywhere on your :ref:`Python path <tut-searchpath>`. In
 
-this tutorial, we'll create our poll app in the same directory as your
 
-:file:`manage.py` file so that it can be imported as its own top-level module,
 
-rather than a submodule of ``mysite``.
 
+Your apps can live anywhere in your :ref:`Python path <tut-searchpath>`. In
 
+this tutorial, we'll create our poll app inside the ``djangotutorial`` folder.
 
 
 To create your app, make sure you're in the same directory as :file:`manage.py`
 
 and type this command:

+ 1 - 1
docs/intro/tutorial05.txt
View File 

@@ -216,7 +216,7 @@ and you'll see something like:
 
     FAIL: test_was_published_recently_with_future_question (polls.tests.QuestionModelTests)
 
     ----------------------------------------------------------------------
 
     Traceback (most recent call last):
 
-      File "/path/to/mysite/polls/tests.py", line 16, in test_was_published_recently_with_future_question
 
+      File "/path/to/djangotutorial/polls/tests.py", line 16, in test_was_published_recently_with_future_question
 
         self.assertIs(future_question.was_published_recently(), False)
 
     AssertionError: True is not False

+ 4 - 4
docs/intro/tutorial07.txt
View File 

@@ -306,10 +306,10 @@ powered by Django itself, and its interfaces use Django's own template system.
 
 Customizing your *project's* templates
 
 --------------------------------------
 
 
-Create a ``templates`` directory in your project directory (the one that
 
-contains ``manage.py``). Templates can live anywhere on your filesystem that
 
-Django can access. (Django runs as whatever user your server runs.) However,
 
-keeping your templates within the project is a good convention to follow.
 
+Create a ``templates`` directory in your ``djangotutorial`` directory.
 
+Templates can live anywhere on your filesystem that Django can access. (Django
 
+runs as whatever user your server runs.) However, keeping your templates within
 
+the project is a good convention to follow.
 
 
 Open your settings file (:file:`mysite/settings.py`, remember) and add a
 
 :setting:`DIRS <TEMPLATES-DIRS>` option in the :setting:`TEMPLATES` setting:

+ 1 - 0
docs/spelling_wordlist
View File 

@@ -141,6 +141,7 @@ Disqus
 
 distro
 
 django
 
 djangoproject
 
+djangotutorial
 
 dm
 
 docstring
 
 docstrings