Hopiu/django-auditlog
1
0
Fork 0
mirror of https://github.com/jazzband/django-auditlog.git synced 2026-05-14 10:33:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve documentation home page

Browse source
This commit is contained in:
Jan-Jelle Kester 2015-05-31 15:14:10 +02:00
parent ff09a69c6f
commit 0c3f839ae2
1 changed files with 11 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/source/index.rst
View file

@ -1,17 +1,17 @@
``django-auditlog`` documentation
=================================
django-auditlog documentation
=============================
``django-auditlog`` (Auditlog) is a reusable app for Django that makes logging object changes a breeze. Auditlog tries
to use as much as Python and Django's built in functionality to keep the list of dependencies as short as possible.
Also, Auditlog aims to be fast and simple to use.
django-auditlog (Auditlog) is a reusable app for Django that makes logging object changes a breeze. Auditlog tries to
use as much as Python and Django's built in functionality to keep the list of dependencies as short as possible. Also,
Auditlog aims to be fast and simple to use.
Auditlog is created out of the need for a simple Django app that logs changes to models, including the user that changed
the models (later referred to as actor). Existing solutions seemed to offer a type of version control, which was not
needed and would cause too much overhead.
The core idea of Auditlog is similar to the log from Django's admin. Unlike the log from Django's admin
(django.contrib.admin) Auditlog is much more flexible and also saves a summary of the changes in JSON format, so changes
can be tracked easily.
The core idea of Auditlog is similar to the log from Django's admin. However, Auditlog is much more flexible than the
log from Django's admin app (:py:mod:`django.contrib.admin`). Also, Auditlog saves a summary of the changes in JSON
format, so changes can be tracked easily.
Contents
--------
@ -28,8 +28,7 @@ Contribute to Auditlog
----------------------
If you found an issue with Auditlog or want to improve the code, please submit an issue and/or pull request via GitHub.
Before submitting a new issue, please make sure there is no issue submitted that involves the same issue.
Before submitting a new issue, please make sure there is no issue submitted that involves the same problem.
GitHub repository: https://github.com/jjkester/django-auditlog
Issues: https://github.com/jjkester/django-auditlog/issues
| GitHub repository: https://github.com/jjkester/django-auditlog
| Issues: https://github.com/jjkester/django-auditlog/issues