From 073ebaba809ef9e70fb50b7f6adc1bc552e3133d Mon Sep 17 00:00:00 2001 From: Garret Wassermann Date: Tue, 27 Aug 2019 21:37:39 -0400 Subject: [PATCH] Update documentation for custom field search --- docs/custom_fields.rst | 2 +- docs/install.rst | 13 +++++-------- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/custom_fields.rst b/docs/custom_fields.rst index d89d3835..1258f5e9 100644 --- a/docs/custom_fields.rst +++ b/docs/custom_fields.rst @@ -5,4 +5,4 @@ django-helpdesk supports custom fields on the ``Ticket`` model. These fields are The demo at http://django-helpdesk-demo.herokuapp.com contains an example of each type of custom field, including a mix of mandatory and optional fields. -Custom fields are relatively inefficient, and you cannot search by them. They can be useful for tracking extra information that your organisation needs but that isn't supported out of the box. +Custom fields are relatively inefficient; you can search them, but this might degrade performance of your installation if you make use of custom fields. They can be useful for tracking extra information that your organisation needs but that isn't supported out of the box. diff --git a/docs/install.rst b/docs/install.rst index 3dc6f8ec..a78ce74d 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -7,21 +7,18 @@ Installation Prerequisites ------------- -Before getting started, ensure your system meets the following dependencies: +Before getting started, ensure your system meets the following recommended dependencies: -* Python 3.4+, or Python 2.7 -* Django 1.11.x (Django 2.0 support is coming in a future release; older - releases such as 1.8-1.10 *may* work, but are not guaranteed. Django's - deprecation policy suggests that any project that worked with 1.8 should - be able to upgrade to 1.11 without any problems) +* Python 3.6+, or Python 2.7 (Python 3.4+ may also work but unsupported) +* Django 1.11.x (Django 2.x should also work though, and recommended for new projects) Ensure any extra Django modules you wish to use are compatible before continuing. **NOTE**: Python 2.7 support is deprecated in both ``django-helpdesk`` and Django. Future releases of ``django-helpdesk`` may remove support for Python 2.7, and Django will no longer support Python 2.7 as of the Django 2.0 release. -It is highly recommended to start new projects using Python 3.4+, or migrate -existing projects to Python 3.4+. +It is highly recommended to start new projects using Python 3.6+, or migrate +existing projects to Python 3.6+. Getting The Code