extern/django-helpdesk
1
0
Fork 1
mirror of https://github.com/django-helpdesk/django-helpdesk.git synced 2025-06-20 01:27:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation updates

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/api.rst
View File

@ -1,6 +1,9 @@
API 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 A REST API (built with ``djangorestframework``) is available in order to list, create, update and delete tickets from
other tools thanks to HTTP requests. other tools thanks to HTTP requests.

5
docs/install.rst
View File

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

7
docs/settings.rst
View File

@ -1,6 +1,9 @@
Settings 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:: First, django-helpdesk needs ``django.core.context_processors.request`` activated, so you must add it to the ``settings.py``. Add the following::
TEMPLATES = [ TEMPLATES = [
@ -87,6 +90,10 @@ These changes are visible throughout django-helpdesk
**Default:** ``HELPDESK_NAVIGATION_ENABLED = False`` **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? - **HELPDESK_TRANSLATE_TICKET_COMMENTS** Show dropdown list of languages that ticket comments can be translated into via Google Translate?
**Default:** ``HELPDESK_TRANSLATE_TICKET_COMMENTS = False`` **Default:** ``HELPDESK_TRANSLATE_TICKET_COMMENTS = False``