diff --git a/docs/reference/project_template.rst b/docs/reference/project_template.rst index 25ecce5932..8485892d3a 100644 --- a/docs/reference/project_template.rst +++ b/docs/reference/project_template.rst @@ -4,28 +4,47 @@ The project template .. code-block:: text mysite/ - core/ - static/ + home/ + migrations/ + __init__.py + 0001_initial.py + 0002_create_homepage.py templates/ - base.html - 404.html - 500.html + home/ + home_page.html + __init__.py + models.py + search/ + templates/ + search/ + search.html + __init__.py + views.py mysite/ settings/ + __init__.py base.py dev.py production.py + static/ + css/ + mysite.css + js/ + mysite.js + templates/ + 404.html + 500.html + base.html + __init__.py + urls.py + wsgi.py manage.py - vagrant/ - provision.sh - Vagrantfile - readme.rst requirements.txt -The "core" app +The "home" app ---------------- -Location: ``/mysite/core/`` +Location: ``/mysite/home/`` This app is here to help get you started quicker by providing a ``HomePage`` model with migrations to create one when you first setup your app. @@ -33,23 +52,13 @@ This app is here to help get you started quicker by providing a ``HomePage`` mod Default templates and static files ---------------------------------- -Location: ``/mysite/core/templates/`` and ``/mysite/core/static/`` +Location: ``/mysite/templates/`` and ``/mysite/static/`` The templates directory contains ``base.html``, ``404.html`` and ``500.html``. These files are very commonly needed on Wagtail sites to they have been added into the template. The static directory contains an empty JavaScript and SASS file. Wagtail uses ``django-compressor`` for compiling and compressing static files. For more information, see: `Django Compressor Documentation `_ -Vagrant configuration ---------------------- - -Location: ``/Vagrantfile`` and ``/vagrant/`` - -If you have Vagrant installed, these files let you easily setup a development environment with PostgreSQL and Elasticsearch inside a virtual machine. - -If you do not want to use Vagrant, you can just delete these files. - - Django settings ---------------