[Django] #32880: Improve logging documentation
Django
-------------------------------------------+-------------------------
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.
Django
--------------------------------------+------------------------------------
Reporter: Daniele Procida | Owner: nobody
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: logging | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak):
* type: New feature => Cleanup/optimization
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/32880#comment:1>
Django
-------------------------------------+-------------------------------------
Reporter: Daniele Procida | Owner: Daniele
Type: | Procida
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: logging | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak):
* owner: nobody => Daniele Procida
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/32880#comment:2>
Django
-------------------------------------+-------------------------------------
Reporter: Daniele Procida | Owner: Daniele
Type: | Procida
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: logging | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by GitHub <noreply@…>):
In [changeset:"64839512a6ed04a29e49e246acf8337b1be2cb8e" 64839512]:
{{{
#!CommitTicketReference repository=""
revision="64839512a6ed04a29e49e246acf8337b1be2cb8e"
Refs #32880 -- Improved some headings and text in logging topic.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32880#comment:3>
Django
-------------------------------------+-------------------------------------
Reporter: Daniele Procida | Owner: Daniele
Type: | Procida
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: logging | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"e9fbd7348013bce753c0f4e0e492007f50a87095" e9fbd734]:
{{{
#!CommitTicketReference repository=""
revision="e9fbd7348013bce753c0f4e0e492007f50a87095"
Refs #32880 -- Improved some how-to notes in logging topic.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32880#comment:4>
Django
-------------------------------------+-------------------------------------
Reporter: Daniele Procida | Owner: Daniele
Type: | Procida
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: logging | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"d79be3ed39b76d3e34431873eec16f6dd354ab17" d79be3e]:
{{{
#!CommitTicketReference repository=""
revision="d79be3ed39b76d3e34431873eec16f6dd354ab17"
Refs #32880 -- Rearranged logging security notes.
Expanded security notes and moved them under a new explanation heading
of their own for future reference and expansion.
Removed specific reference to Sentry since there are multiple
third-party services that fulfill that role.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32880#comment:5>
Django
-------------------------------------+-------------------------------------
Reporter: Daniele Procida | Owner: Daniele
Type: | Procida
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: logging | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"e3d55eeb14936e82257ac6a005e9f9a06def3d00" e3d55eeb]:
{{{
#!CommitTicketReference repository=""
revision="e3d55eeb14936e82257ac6a005e9f9a06def3d00"
Refs #32880 -- Moved logging reference to new document.
Completed a first step in moving reference and how-to material out of
the topic document.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32880#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: Daniele Procida | Owner: Daniele
Type: | Procida
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: logging | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"62988afbea7c7ea6ea7eb76382b3a87a5ccf310c" 62988afb]:
{{{
#!CommitTicketReference repository=""
revision="62988afbea7c7ea6ea7eb76382b3a87a5ccf310c"
Refs #32880 -- Renamed/reordered logging topic sections.
Moved sections so that how-to type material is all together, and
renamed headings so it's clearer what those sections are about, in
anticipation of creating a separate how-to document and expanding
the material.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32880#comment:7>
Django
-------------------------------------+-------------------------------------
Reporter: Daniele Procida | Owner: Daniele
Type: | Procida
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: logging | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"013a1824d3c57b7ffc5240bc03d219a4a290aa3d" 013a182]:
{{{
#!CommitTicketReference repository=""
revision="013a1824d3c57b7ffc5240bc03d219a4a290aa3d"
Refs #32880 -- Created a new logging how-to document.
Moved how-to material from topic document into a new document, and
added new material. Introduced minor improvements to logging
reference document.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32880#comment:8>
Django
-------------------------------------+-------------------------------------
Reporter: Daniele Procida | Owner: Daniele
Type: | Procida
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: logging | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by GitHub <noreply@…>):
In [changeset:"22fbebc7444c8974f101c146f0fc18fe64ab48f6" 22fbebc]:
{{{
#!CommitTicketReference repository=""
revision="22fbebc7444c8974f101c146f0fc18fe64ab48f6"
Refs #32880 -- Made some titles consistent in how-to documents.
This retitles documents for consistency, since some already (correctly)
begin "How to...".
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32880#comment:9>
Django
-------------------------------------+-------------------------------------
Reporter: Daniele Procida | Owner: Daniele
Type: | Procida
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: logging | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak):
Daniele, is there anything left for this ticket? or can we close it as
fixed. I think it's ready.
--
Ticket URL: <https://code.djangoproject.com/ticket/32880#comment:10>
Django
-------------------------------------+-------------------------------------
Reporter: Daniele Procida | Owner: Daniele
Type: | Procida
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed
Keywords: logging | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak):
* status: assigned => closed
* resolution: => fixed
--
Ticket URL: <https://code.djangoproject.com/ticket/32880#comment:11>
Django
-------------------------------------+-------------------------------------
Reporter: Daniele Procida | Owner: Daniele
Type: | Procida
Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: logging | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by GitHub <noreply@…>):
In [changeset:"f331eba6d576752dd79c4b37c41d981daa537fe6" f331eba6]:
{{{
#!CommitTicketReference repository=""
revision="f331eba6d576752dd79c4b37c41d981daa537fe6"
Refs #32880 -- Made remaining titles consistent in how-to documents.
Follow up to 22fbebc7444c8974f101c146f0fc18fe64ab48f6.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32880#comment:12>