0 5 1
default
Branko Majic (branko) - 2 years ago 2017-12-22 12:39:52
branko@majic.rs
CONNT-25: Updated documentation: - Marked Django 1.11.x as the only supported Django version. - Updated some copyright notices. - Updated installation and quick-start instructions for use with new version of Django. - Removed unneeded warning about pip version. - Updated instructions to emphasize that 'crispy_forms' must be included in list of installed applications. - Added dedicated section for upgrade instructions. Covered some general principles and upgrade from 0.3.x to 1.0.x. - Updated release notes. - Added information about Graphviz being the external dependency.
6 files changed with 99 insertions and 51 deletions:
↑ Collapse Diff ↑
...
 
@@ -28,7 +28,12 @@ At time of this writing, Django Conntrac
28 28
 
following Django and Python versions:
29 29
 

	
30 30
 
- *Python 2.7.x*
31
 
- *Django 1.5.x*
31
 
- *Django 1.11.x*
32
 

	
33
 
In addition, *Django Conntrackt* uses the following external
34
 
dependencies:
35
 

	
36
 
- `Graphviz <https://graphviz.org/>`_
32 37
 

	
33 38
 

	
34 39
 
Why was this application created?
1
 
.. Copyright (C) 2013 Branko Majic
1
 
.. Copyright (C) 2013-2017 Branko Majic
2 2
 

	
3 3
 
   This file is part of Django Conntrackt documentation.
4 4
 

	
...
 
@@ -68,6 +68,7 @@ Contents
68 68
 
   about
69 69
 
   installation
70 70
 
   quickstart
71
 
   upgrading
71 72
 
   usage
72 73
 
   development
73 74
 
   releaseprocedures
1
 
.. Copyright (C) 2013 Branko Majic
1
 
.. Copyright (C) 2013-2017 Branko Majic
2 2
 

	
3 3
 
   This file is part of Django Conntrackt documentation.
4 4
 

	
...
 
@@ -11,7 +11,13 @@
11 11
 
Installation
12 12
 
============
13 13
 

	
14
 
Django Conntrackt can be installed through one of the following methods:
14
 
*Django Conntrackt* has the following prerequisites that need to be
15
 
satisfied on the operating system level:
16
 

	
17
 
- `Graphviz <https://graphviz.org/>`_, used for generating the
18
 
  diagrams.
19
 

	
20
 
*Django Conntrackt* can be installed through one of the following methods:
15 21
 

	
16 22
 
* Using *pip*, which is the recommended way for production
17 23
 
  websites.
...
 
@@ -30,16 +36,6 @@ Mercurial repository, use the following 
30 36
 

	
31 37
 
 pip install -e hg+http://code.majic.rs/conntrackt#egg=conntrackt
32 38
 

	
33
 
.. warning::
34
 

	
35
 
   You will need to update the ``pip`` installation in your virtual environment if you get the following error while running the above command::
36
 

	
37
 
     AttributeError: 'NoneType' object has no attribute 'skip_requirements_regex'
38
 

	
39
 
   You can update ``pip`` to latest version with::
40
 

	
41
 
     pip install -U pip
42
 

	
43 39
 
After this you should proceed to :ref:`configure your Django installation <configuring-django>`.
44 40
 

	
45 41
 

	
...
 
@@ -51,8 +47,9 @@ Configuring your Django installation
51 47
 
Once the Django Conntrackt has been installed, you need to perform the following
52 48
 
steps in order to make it available inside of your Django project:
53 49
 

	
54
 
#. Edit your project's settings configuration file (``settings.py``), and update
55
 
   the ``INSTALLED_APPS`` to include applications ``south``, ``braces`` and ``conntrackt``.
50
 
#. Edit your project's settings configuration file (``settings.py``),
51
 
   and update the ``INSTALLED_APPS`` to include applications
52
 
   ``braces``, ``crispy_forms``, and ``conntrackt``.
56 53
 

	
57 54
 
#. Edit your project's URL configuration file (``urls.py``), and add the
58 55
 
   following line to the ``urlpatterns`` setting::
...
 
@@ -61,10 +58,11 @@ steps in order to make it available insi
61 58
 

	
62 59
 
#. Create the necessary tables used for Django Conntrackt by running::
63 60
 

	
64
 
   ./manage.py syncdb
61
 
   ./manage.py migrate
65 62
 

	
66 63
 
After this the Django Conntrackt application will be available under the
67 64
 
``/conntrackt/`` path (relative to your Django project's base URL).
68 65
 

	
69
 
If you have enabled ``django.contrib.admin``, you should be able to add new
70
 
Conntrackt data through the admin interface.
66
 
If you have enabled ``django.contrib.admin``, you should be able to
67
 
add new Conntrackt data through admin interface as well - in addition
68
 
to native data entry provided by application.
1
 
.. Copyright (C) 2013 Branko Majic
1
 
.. Copyright (C) 2013-2017 Branko Majic
2 2
 

	
3 3
 
   This file is part of Django Conntrackt documentation.
4 4
 

	
...
 
@@ -33,16 +33,6 @@ Install Django Conntrackt with its requi
33 33
 
  workon conntrackt
34 34
 
  pip install django-conntrackt
35 35
 

	
36
 
.. warning::
37
 

	
38
 
   You will need to update the ``pip`` installation in your virtual environment if you get the following error while running the above command::
39
 

	
40
 
     AttributeError: 'NoneType' object has no attribute 'skip_requirements_regex'
41
 

	
42
 
   You can update ``pip`` to latest version with::
43
 

	
44
 
     pip install -U pip
45
 

	
46 36
 
Start a new Django Conntrackt project::
47 37
 

	
48 38
 
  django-admin.py startproject conntrackt_test
...
 
@@ -50,30 +40,16 @@ Start a new Django Conntrackt project::
50 40
 
Edit configuration file ``conntrackt_test/conntrackt_test/settings.py`` to set-up
51 41
 
some basic settings:
52 42
 

	
53
 
#. Under ``DATABASES`` set parameter ``ENGINE`` to ``'django.db.backends.sqlite3'``.
54
 
#. Under ``DATABASES`` set parameter ``NAME`` to ``'conntrackt_test.sqlite'``.
55
 
#. Under ``INSTALLED_APPS`` uncomment the line ``'django.contrib.admin'``.
56 43
 
#. Under ``INSTALLED_APPS`` append lines::
57 44
 

	
58
 
     'south',
45
 
     'crispy_forms',
59 46
 
     'braces',
60 47
 
     'conntrackt',
61 48
 

	
62
 
#. Append the following lines to the end of the file::
63
 

	
64
 
     from django.conf.global_settings import TEMPLATE_CONTEXT_PROCESSORS
65
 
     TEMPLATE_CONTEXT_PROCESSORS += (
66
 
         "django.core.context_processors.request",
67
 
     )
68
 

	
69
 

	
70 49
 
Edit the URL configuration file ``conntrackt_test/conntrackt_test/urls/.py`` to
71 50
 
set-up the URLs for the admin website and Conntrackt itself:
72 51
 

	
73 52
 
#. At the top of the file, add line ``from django.http import HttpResponseRedirect``.
74
 
#. Uncomment line ``from django.contrib import admin``.
75
 
#. Uncomment line ``admin.autodiscover()``.
76
 
#. Uncomment line ``url(r'^admin/', include(admin.site.urls)),``
77 53
 
#. Under ``urlpatterns`` append lines::
78 54
 

	
79 55
 
     url(r'^$', lambda r : HttpResponseRedirect('conntrackt/')),
...
 
@@ -82,7 +58,6 @@ set-up the URLs for the admin website an
82 58
 
Set-up the database for the project::
83 59
 

	
84 60
 
  cd conntrackt_test/
85
 
  python manage.py syncdb
86 61
 
  python manage.py migrate
87 62
 

	
88 63
 
You will be prompted to provide some additional information:
...
 
@@ -103,4 +78,3 @@ You can now explore the functionality of
103 78
 

	
104 79
 
If you have any problems getting around and understanding how the applications
105 80
 
works, have a look at the :ref:`usage guide <usage>`.
106
 

	
1
 
.. Copyright (C) 2013 Branko Majic
1
 
.. Copyright (C) 2013-2017 Branko Majic
2 2
 

	
3 3
 
   This file is part of Django Conntrackt documentation.
4 4
 

	
...
 
@@ -17,9 +17,10 @@ dev
17 17
 

	
18 18
 
Breaking changes:
19 19
 

	
20
 
* Django Conntrackt now depends on Django 1.10. In addition to official
21
 
  Django documentation, there is a dedicated upgrade guide that deals
22
 
  with the most basic installation.
20
 
* Django Conntrackt now depends on Django 1.11. In addition to
21
 
  official Django documentation for project upgrades, there is a
22
 
  section describing what needs to be done in order to upgrade the
23
 
  application itself.
23 24
 
  [ `CONNT-25 <https://projects.majic.rs/conntrackt/issues/CONNT-30>`_ ]
24 25
 

	
25 26
 
New features/improvements:
 
new file 100644
1
 
.. Copyright (C) 2017 Branko Majic
2
 

	
3
 
   This file is part of Django Conntrackt documentation.
4
 

	
5
 
   This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
6
 
   Unported License. To view a copy of this license, visit
7
 
   http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
8
 
   Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
9
 

	
10
 

	
11
 
Upgrading
12
 
=========
13
 

	
14
 
This section covers the necessary upgrade steps between different
15
 
versions.
16
 

	
17
 
In general, it is always useful to go thorugh the release notes to
18
 
ensure there no surprises are encountered during the upgrade.
19
 

	
20
 
Upgrading from one **patch version** to another (e.g. ``0.3.0`` to
21
 
``0.3.1``) should be safe, and should not require any additional steps
22
 
beyond installing new package version. Patch versions include only bug
23
 
and security-related fixes.
24
 

	
25
 
Upgrading from one **minor version** to another (e.g. ``0.2.0`` to
26
 
``0.3.0`` might require some small maintenance tasks, such as running
27
 
migrations, or refreshing the static files. In general no breaking
28
 
changes should be introduced, and downtime should be minimal.
29
 

	
30
 
Upgrading from one **major version** to another (e.g. ``0.3.1`` to
31
 
``1.0.0``) is likely to require a number of changes, and you should
32
 
make sure to review both the release notes, and any other documented
33
 
instructions outlined below.
34
 

	
35
 
Major version upgrades should be performed only for supported upgrade
36
 
paths. This usually means bringing your current installation to the
37
 
latest minor release version before jumping to the next major
38
 
release. Should you need to jump multiple versions, do it one step at
39
 
a time, following along with any necessary changes. Currently
40
 
supported upgrade paths are:
41
 

	
42
 
- From version ``0.3.x`` to version ``1.0.x``.
43
 

	
44
 

	
45
 
Upgrading from ``0.3.x`` to ``1.0.x``
46
 
-------------------------------------
47
 

	
48
 
Version ``1.0.x`` brings in a lot of changes related to dependency
49
 
upgrades. This is a big step in terms of Django versions (from Django
50
 
1.5.x to Django 1.11.x), with application functionality itself left
51
 
untouched.
52
 

	
53
 
In particular, since support for Django 1.5.x has been dropped, you
54
 
will need to upgrade your project to Django 1.11.x. Depending on your
55
 
project customisations, it may be easier to start a new project and
56
 
move over any relevant configuration to it.
57
 

	
58
 
For *Django Conntrackt* itself, at least the following changes must be
59
 
made:
60
 

	
61
 
- Removing ``south`` from list of installed applications in project
62
 
  settings. *Django Conntrackt* now utilises the native migrations.
63
 
- Run database migrations with::
64
 

	
65
 
    python manage.py migrate
66
 

	
67
 
- Ensure static data served by external server are up-to-date with::
68
 

	
69
 
    python manage.py collectstatic
0 comments (0 inline, 0 general)