# HG changeset patch # User Branko Majic # Date 2017-12-22 13:02:01 # Node ID ff99fef4e9a70a539867a0471f376717a27ef57d # Parent d7c64b3800af71281fbcd231e4b030595e6f83f8 CONNT-25: Fixed discrepancies and erros in installation/quick-start documentation. diff --git a/docs/installation.rst b/docs/installation.rst --- a/docs/installation.rst +++ b/docs/installation.rst @@ -51,14 +51,19 @@ steps in order to make it available insi and update the ``INSTALLED_APPS`` to include applications ``braces``, ``crispy_forms``, and ``conntrackt``. -#. Edit your project's URL configuration file (``urls.py``), and add the - following line to the ``urlpatterns`` setting:: +#. Edit your project's URL configuration file (``urls.py``). + + Update the import command for urls module to look like:: + + from django.conf.urls import url, include + + Add the following line to the ``urlpatterns`` setting:: url(r'^conntrackt/', include('conntrackt.urls')), -#. Create the necessary tables used for Django Conntrackt by running:: +#. Create the necessary tables used for *Django Conntrackt*:: - ./manage.py migrate + ./manage.py migrate After this the Django Conntrackt application will be available under the ``/conntrackt/`` path (relative to your Django project's base URL). diff --git a/docs/quickstart.rst b/docs/quickstart.rst --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -46,10 +46,17 @@ some basic settings: 'braces', 'conntrackt', -Edit the URL configuration file ``conntrackt_test/conntrackt_test/urls/.py`` to +Edit the URL configuration file ``conntrackt_test/conntrackt_test/urls.py`` to set-up the URLs for the admin website and Conntrackt itself: -#. At the top of the file, add line ``from django.http import HttpResponseRedirect``. +#. At the top of the file, add line:: + + from django.http import HttpResponseRedirect + +#. Update the import command for urls module to look like:: + + from django.conf.urls import url, include + #. Under ``urlpatterns`` append lines:: url(r'^$', lambda r : HttpResponseRedirect('conntrackt/')), @@ -60,9 +67,12 @@ Set-up the database for the project:: cd conntrackt_test/ python manage.py migrate +Create the initial superadmin user:: + + python manage.py createsuperuser + You will be prompted to provide some additional information: -#. When prompted to create a superuser, answer ``yes``. #. Provide the desired username when prompted for it. #. Provide the desired e-mail address when prompted for it. #. Provide the desired password for created user.