#32880: Improve logging documentation
-------------------------------------------+-------------------------
Reporter: Daniele Procida | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: dev
Severity: Normal | Keywords: logging
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------------+-------------------------
The Django logging topic contains a lot of valuable information, but its
structure can be greatly improved. I plan to refactor it across three
documents:
* a how-to guide for practical usage
* a reference guide containing technical description
* the existing topic that explains logging
This is in accordance with [https://docs.djangoproject.com/en/3.2/#how-
the-documentation-is-organized Django's own documentation structure], and
the principles outlined in the [https://diataxis.fr Diátaxis framework].
As agreed with the Django fellows, pull requests for this will be small
and frequent, and the work will proceed iteratively rather than delivering
a finished tranche of work in one piece.
--
Ticket URL: <https://code.djangoproject.com/ticket/32880>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/050.b794d6824c62ee30f1880f2af9b67b32%40djangoproject.com.
