#32880 closed Cleanup/optimization (fixed)
Improve logging documentation
Reported by: | Daniele Procida | Owned by: | Daniele Procida |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | logging |
Cc: | Triage Stage: | Accepted | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
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 Django's own documentation structure, and the principles outlined in the 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.
Change History (12)
comment:1 by , 3 years ago
Triage Stage: | Unreviewed → Accepted |
---|---|
Type: | New feature → Cleanup/optimization |
comment:2 by , 3 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:3 by , 3 years ago
comment:10 by , 3 years ago
Daniele, is there anything left for this ticket? or can we close it as fixed. I think it's ready.
comment:11 by , 3 years ago
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
In 64839512: