Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#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 Mariusz Felisiak, 5 years ago

Triage Stage: Unreviewed → Accepted
Type: New feature → Cleanup/optimization

comment:2 by Mariusz Felisiak, 5 years ago

Owner: changed from nobody to Daniele Procida
Status: new → assigned

comment:3 by GitHub <noreply@…>, 5 years ago

In 64839512:

Refs #32880 -- Improved some headings and text in logging topic.

comment:4 by Mariusz Felisiak <felisiak.mariusz@…>, 5 years ago

In e9fbd734:

Refs #32880 -- Improved some how-to notes in logging topic.

comment:5 by Mariusz Felisiak <felisiak.mariusz@…>, 5 years ago

In d79be3e:

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.

comment:6 by Mariusz Felisiak <felisiak.mariusz@…>, 5 years ago

In e3d55eeb:

Refs #32880 -- Moved logging reference to new document.

Completed a first step in moving reference and how-to material out of
the topic document.

comment:7 by Mariusz Felisiak <felisiak.mariusz@…>, 5 years ago

In 62988afb:

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.

comment:8 by Mariusz Felisiak <felisiak.mariusz@…>, 5 years ago

In 013a182:

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.

comment:9 by GitHub <noreply@…>, 5 years ago

In 22fbebc:

Refs #32880 -- Made some titles consistent in how-to documents.

This retitles documents for consistency, since some already (correctly)
begin "How to...".

comment:10 by Mariusz Felisiak, 5 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 Mariusz Felisiak, 5 years ago

Resolution: → fixed
Status: assigned → closed

comment:12 by GitHub <noreply@…>, 5 years ago

In f331eba6:

Refs #32880 -- Made remaining titles consistent in how-to documents.

Follow up to 22fbebc7444c8974f101c146f0fc18fe64ab48f6.

Note: See TracTickets for help on using tickets.
Back to Top