Opened 2 years ago

Closed 2 years ago

#34054 closed Cleanup/optimization (fixed)

Create a topic about fixtures

Reported by: Filip Łajszczak Owned by: Filip Łajszczak
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Daniele Procida Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Filip Łajszczak)

From working on #26975 and from reading discussion on the first PR it looks like the current documentation of fixtures requires some work.

Currently information about fixtures is dispersed between different parts of the docs:

There are places where fixtures are mentioned without any prior explanation and without any link to more information, like in dumpdata command docs

There are places where fixtures should be mentioned by name but are not, like seriaIization Topic

Looks like creation of the separate Topic under Models and databases could be the solution.

Here is the draft PR for the discussion. That should also wait for the previous simler PR to be resolved and than modified accordingly.

Change History (7)

comment:1 by Filip Łajszczak, 2 years ago

Description: modified (diff)
Has patch: set
Patch needs improvement: set

comment:2 by Filip Łajszczak, 2 years ago

Description: modified (diff)

comment:3 by Mariusz Felisiak, 2 years ago

Cc: Daniele Procida added
Triage Stage: UnreviewedAccepted

Thanks for the proposition. Please follow the principles outlined in the Diátaxis framework about Explanation (=Django topics.)

in reply to:  3 comment:4 by Filip Łajszczak, 2 years ago

Replying to Mariusz Felisiak:

I was considering it and that's one of the reasons I left the PR in draft state. It's find it very much on the border of diátaxis' explanation and reference.

comment:5 by Mariusz Felisiak, 2 years ago

Patch needs improvement: unset

comment:6 by Mariusz Felisiak, 2 years ago

Triage Stage: AcceptedReady for checkin

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

Resolution: fixed
Status: assignedclosed

In 61030595:

Fixed #34054 -- Created a new fixtures topic.

Moved material from django-admin document into a new document, and
added new material.

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@…>

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