[Django] #34054: Create a topic about fixtures
Django
-------------------------------------+-------------------------------------
Reporter: Filip | Owner: Filip Łajszczak
Łajszczak |
Type: | Status: assigned
Cleanup/optimization |
Component: | Version: dev
Documentation |
Severity: Normal | Keywords:
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
**Background:** From working on #26975 and from reading discussion on the
[[https://github.com/django/django/pull/6996#issuecomment-238020222|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:
* general definition of fixtures lives under reference for `loaddata`
[[https://docs.djangoproject.com/en/dev/ref/django-
admin/#what-s-a-fixture|command]]
* example of the hand written fixture is in the
[[https://docs.djangoproject.com/en/dev/howto/initial-data/|Initial data
how-to guide]]
* other bits one can find in
[[https://docs.djangoproject.com/en/dev/topics/testing/tools/#fixture-
loading|testing tools]]
There are places where fixtures are mentioned without any prior
explanation and without any link to more information, like in `dumpdata`
[[https://docs.djangoproject.com/en/dev/ref/django-admin/#fixtures-
compression|command docs]]
There are places where fixtures should be mentioned by name but are not,
like
[[https://docs.djangoproject.com/en/dev/topics/serialization/|seriaIization
Topic]]
Looks like creation of the separate Topic under
[[https://docs.djangoproject.com/en/dev/topics/db/|Models and databases]]
could be the solution.
--
Ticket URL: <https://code.djangoproject.com/ticket/34054>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
-------------------------------------+-------------------------------------
Type: | Łajszczak
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
* has_patch: 0 => 1
Old description:
New description:
Here is the [[https://github.com/django/django/pull/16112|draft PR]] for
the discussion. That should also wait for the previous
[[https://github.com/django/django/pull/16104|simler PR]] to be resolved
and than modified accordingly.
--
--
Ticket URL: <https://code.djangoproject.com/ticket/34054#comment:1>
Django
-------------------------------------+-------------------------------------
Reporter: Filip Łajszczak | Owner: Filip
Type: | Łajszczak
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Old description:
> Here is the [[https://github.com/django/django/pull/16112|draft PR]] for
> the discussion. That should also wait for the previous
> [[https://github.com/django/django/pull/16104|simler PR]] to be resolved
> and than modified accordingly.
New description:
--
--
Ticket URL: <https://code.djangoproject.com/ticket/34054#comment:2>
Django
-------------------------------------+-------------------------------------
Reporter: Filip Łajszczak | Owner: Filip
Type: | Łajszczak
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* cc: Daniele Procida (added)
* stage: Unreviewed => Accepted
Comment:
Thanks for the proposition. Please follow the principles outlined in the
[https://diataxis.fr/ Diátaxis framework] about `Explanation` (`=Django
topics`.)
--
Ticket URL: <https://code.djangoproject.com/ticket/34054#comment:3>
Django
-------------------------------------+-------------------------------------
Reporter: Filip Łajszczak | Owner: Filip
Type: | Łajszczak
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Filip Łajszczak):
Replying to [comment:3 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.
--
Ticket URL: <https://code.djangoproject.com/ticket/34054#comment:4>
Django
-------------------------------------+-------------------------------------
Reporter: Filip Łajszczak | Owner: Filip
Type: | Łajszczak
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/34054#comment:5>
Django
-------------------------------------+-------------------------------------
Reporter: Filip Łajszczak | Owner: Filip
Type: | Łajszczak
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/34054#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: Filip Łajszczak | Owner: Filip
Type: | Łajszczak
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"6103059592c6c1bd171977d26b76ee475175043c" 61030595]:
{{{
#!CommitTicketReference repository=""
revision="6103059592c6c1bd171977d26b76ee475175043c"
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...@gmail.com>
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/34054#comment:7>