Opened 9 years ago
Last modified 10 months ago
#24989 new New feature
Introduce contributor facing documentation for django.db.migrations
Reported by: | Markus Holtermann | Owned by: | |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description (last modified by )
It would be helpful for new contributors as well as for other core devs not involved in certain parts of Django, to have documentation that outlines how these components work. Tim proposed to add that documentation to docs/internals/
. I'd put it into docs/internals/api/
E.g. in migrations: you have a ModelState
and to detect changes the autodetector takes all migrations and build the final model representation and then compares this ProjectState
to the ProjectState
constructed from all currently available models.
Change History (6)
comment:1 by , 9 years ago
comment:2 by , 9 years ago
Description: | modified (diff) |
---|---|
Owner: | changed from | to
Status: | new → assigned |
Summary: | Introduce low-level documentation on Django's components → Introduce contributor facing documentation for django.db.migrations |
Triage Stage: | Unreviewed → Accepted |
comment:3 by , 8 years ago
Commenting to subscribe to this ticket.
(Cannot add to cc as being detected as spam)
comment:4 by , 4 years ago
Owner: | removed |
---|---|
Status: | assigned → new |
follow-up: 6 comment:5 by , 10 months ago
I think that this tiket should cover a broader need. https://forum.djangoproject.com/t/internal-organization-of-the-django-project/18490
comment:6 by , 10 months ago
Replying to HAMA Barhamou:
I think that this tiket should cover a broader need. https://forum.djangoproject.com/t/internal-organization-of-the-django-project/18490
Hey HAMA Barhamou, thank you for your interest in making Django better, but please note that as mentioned in the first comment from Tim, this ticket is intentionally scoped to only documenting the database migrations machinery.
I think the idea is accepted, but a ticket is needed for each thing you want to document, not all of them in one ticket. Do you want to retitle this one to cover migrations?