Skip to content

Commit

Permalink
Update documentation for custom field search
Browse files Browse the repository at this point in the history
  • Loading branch information
gwasser committed Aug 28, 2019
1 parent 4adec7c commit 073ebab
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/custom_fields.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
13 changes: 5 additions & 8 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 073ebab

Please sign in to comment.