Opened 10 years ago
Last modified 14 months ago
#24989 new New feature
Introduce low-level documentation on Django's components — at Initial Version
| Reported by: | Markus Holtermann | Owned by: | nobody |
|---|---|---|---|
| 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 |
| Pull Requests: | |||
Description ¶
I first had the idea a Django: Under the Hood 2014, but abandoned it. A couple of days ago the idea came up in IRC again:
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.
I.e. 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.
Tim proposed to add that documentation to docs/internals/. I'd put it into docs/internals/api/
According to the ticket's flags, the next step(s) to move this issue forward are:
- To provide a patch by sending a pull request. Claim the ticket when you start working so that someone else doesn't duplicate effort. Before sending a pull request, review your work against the patch review checklist. Check the "Has patch" flag on the ticket after sending a pull request and include a link to the pull request in the ticket comment when making that update. The usual format is:
[https://github.com/django/django/pull/#### PR].