#34054: Create a topic about fixtures
-------------------------------------+-------------------------------------
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
-------------------------------------+-------------------------------------
Description changed by Filip Łajszczak:
Old description:
> **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.
>
> 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:
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.
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:2>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/0107018374cca803-95e3deb6-127a-46e6-9542-32c00a8c051d-000000%40eu-central-1.amazonses.com.
