From 15593339934336fe32f96e5514b8369e5827beda Mon Sep 17 00:00:00 2001 From: Garret Wassermann Date: Fri, 20 Aug 2021 02:05:21 -0400 Subject: [PATCH] Fix some docs and migrations in prep for 0.3 release, see #878 --- demo/demodesk/config/settings.py | 3 +- docs/index.rst | 7 +---- docs/install.rst | 2 +- docs/upgrade.rst | 29 +++++++++++++++++++ .../0035_alter_email_on_ticket_change.py | 19 ++++++++++++ requirements-no-pinax.txt | 14 +++++++++ requirements.txt | 1 + 7 files changed, 66 insertions(+), 9 deletions(-) create mode 100644 docs/upgrade.rst create mode 100644 helpdesk/migrations/0035_alter_email_on_ticket_change.py create mode 100644 requirements-no-pinax.txt diff --git a/demo/demodesk/config/settings.py b/demo/demodesk/config/settings.py index 4ade80d6..2a11d213 100644 --- a/demo/demodesk/config/settings.py +++ b/demo/demodesk/config/settings.py @@ -38,12 +38,11 @@ INSTALLED_APPS = [ 'django.contrib.sites', 'django.contrib.humanize', 'bootstrap4form', - 'account', # Required by pinax-teams 'pinax.invitations', # required by pinax-teams 'pinax.teams', # team support - 'helpdesk', # This is us! 'reversion', # required by pinax-teams + 'helpdesk', # This is us! ] MIDDLEWARE = [ diff --git a/docs/index.rst b/docs/index.rst index e93cbde2..15888094 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,7 @@ Contents :glob: install + upgrade configuration settings spam @@ -68,10 +69,4 @@ Licensing --------- django-helpdesk is released under the BSD license, however it packages 3rd party applications which may be using a different license. More details can be found in the :doc:`license` documentation. -Dependencies ------------- - -1. Python 3.4+ (or 2.7, but deprecated and support will be removed next release) -2. Django 1.11 or newer -3. An existing **working** Django project with database etc. If you cannot log into the Admin, you won't get this product working! This means you **must** run `migrate` **before** you add ``helpdesk`` to your ``INSTALLED_APPS``. diff --git a/docs/install.rst b/docs/install.rst index 0a21bc2e..9267bb35 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -61,8 +61,8 @@ errors with trying to create User settings. 'account', # Required by pinax-teams 'pinax.invitations', # required by pinax-teams 'pinax.teams', # team support - 'helpdesk', # This is us! 'reversion', # required by pinax-teams + 'helpdesk', # This is us! ) Note: you do not need to use pinax-teams. To dissable teams see the :doc:`teams` section. diff --git a/docs/upgrade.rst b/docs/upgrade.rst new file mode 100644 index 00000000..117a7cf1 --- /dev/null +++ b/docs/upgrade.rst @@ -0,0 +1,29 @@ +Upgrading +========= + +Your ``django-helpdesk`` installation can be upgraded to the latest version using the release notes below. + + +Prerequisites +------------- + +Please consult the Installation instructions for general instructions and tips. +The tips below are based on modifications of the original installation instructions. + + +0.2 -> 0.3 +---------- + +- Under `INSTALLED_APPS`, `bootstrapform` needs to be replaced with `bootstrap4form` + +- Unless turning off `pinax_teams`, need to add the following to `INSTALLED_APPS` for `pinax_teams`: + ``` + "account", + "pinax.invitations", + "pinax.teams", + "reversion", + ``` + +- If using `send_templated_mail`, then it now needs to be imported from `helpdesk.templated_email` + + diff --git a/helpdesk/migrations/0035_alter_email_on_ticket_change.py b/helpdesk/migrations/0035_alter_email_on_ticket_change.py new file mode 100644 index 00000000..7cf31029 --- /dev/null +++ b/helpdesk/migrations/0035_alter_email_on_ticket_change.py @@ -0,0 +1,19 @@ +# Generated by Django 3.1.13 on 2021-08-18 14:30 + +from django.db import migrations, models +import helpdesk.models + + +class Migration(migrations.Migration): + + dependencies = [ + ('helpdesk', '0034_create_email_template_for_merged'), + ] + + operations = [ + migrations.AlterField( + model_name='usersettings', + name='email_on_ticket_change', + field=models.BooleanField(default=helpdesk.models.email_on_ticket_change_default, help_text="If you're the ticket owner and the ticket is changed via the web by somebody else,do you want to receive an e-mail?", verbose_name='E-mail me on ticket change?'), + ), + ] diff --git a/requirements-no-pinax.txt b/requirements-no-pinax.txt new file mode 100644 index 00000000..eeebb7c5 --- /dev/null +++ b/requirements-no-pinax.txt @@ -0,0 +1,14 @@ +Django>=2.2,<4 +django-bootstrap4-form +celery +django-celery-beat +email-reply-parser +akismet +markdown +beautifulsoup4 +lxml +simplejson +pytz +six +djangorestframework +django-model-utils diff --git a/requirements.txt b/requirements.txt index eeebb7c5..2bba41d2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -10,5 +10,6 @@ lxml simplejson pytz six +pinax_teams djangorestframework django-model-utils