Documentation updates

This commit is contained in:
Christopher Broderick 2025-05-14 15:18:01 +01:00
parent c8eab7b111
commit b94cb9f1cb
3 changed files with 14 additions and 1 deletions

View File

@ -1,6 +1,9 @@
API
===
.. contents:: In this document...
:depth: 2
A REST API (built with ``djangorestframework``) is available in order to list, create, update and delete tickets from
other tools thanks to HTTP requests.

View File

@ -1,10 +1,13 @@
Installation/integration into an existing Django application
============
============================================================
.. note::
For standalone installation, refer to the :doc:`standalone installation docs <standalone>`.
.. contents:: In this document...
:depth: 2
``django-helpdesk`` installation isn't difficult, but it requires you have a bit
of existing know-how about Django.

View File

@ -1,6 +1,9 @@
Settings
========
.. contents:: In this document...
:depth: 2
First, django-helpdesk needs ``django.core.context_processors.request`` activated, so you must add it to the ``settings.py``. Add the following::
TEMPLATES = [
@ -86,6 +89,10 @@ These changes are visible throughout django-helpdesk
- **HELPDESK_NAVIGATION_ENABLED** Show extended navigation by default, to all users, irrespective of staff status?
**Default:** ``HELPDESK_NAVIGATION_ENABLED = False``
- **HELPDESK_SHOW_MY_TICKETS_IN_NAV_FOR_STAFF** Show "My tickets" for staff. Typically used for help desk deploymnets that allow staff to create tickets to action other staff members.
**Default:** ``HELPDESK_SHOW_MY_TICKETS_IN_NAV_FOR_STAFF = True``
- **HELPDESK_TRANSLATE_TICKET_COMMENTS** Show dropdown list of languages that ticket comments can be translated into via Google Translate?