Opened 13 years ago
Closed 13 years ago
#17933 closed Cleanup/optimization (fixed)
"Writing documentation" needs link to check out documentation
Reported by: | rmattb | Owned by: | Thomas Westfeld |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | lemaire.adrien@… | Triage Stage: | Accepted |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
"Contributing to Django" https://docs.djangoproject.com/en/dev/internals/contributing/
links to "Writing documentation" https://docs.djangoproject.com/en/dev/internals/contributing/writing-documentation/
but there's no mention from there of where to get the code to edit,
I've added a section explaining where to get the code (check out trunk), and why (existing release docs are frozen).
Patch attached. :)
Attachments (1)
Change History (7)
by , 13 years ago
Attachment: | 17933-writing-documentation-link-to-code.diff added |
---|
comment:1 by , 13 years ago
Cc: | added |
---|---|
Easy pickings: | set |
Triage Stage: | Unreviewed → Accepted |
comment:2 by , 13 years ago
Owner: | changed from | to
---|
comment:4 by , 13 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
comment:5 by , 13 years ago
Resolution: | fixed |
---|---|
Status: | closed → reopened |
This commit contains a reference to a "differences-between-doc-versions" label, but no such label exists in the the docs.
I thought that I had inadvertently removed this label during my extensive changes to the "contributing" section of the docs (#18436), but that doesn't appear to be true. Actually I couldn't find any such label in Django's history:
% git log -Sdifferences-between-doc-versions commit 87ff89d12d109066ff355ed267787d32a6b5aeb7 Author: Adrian Holovaty <adrian@holovaty.com> Date: Thu Jun 7 11:32:28 2012 -0500 Fixed #17933 -- Added intro note to writing-documentation.txt Based on initial patch by Thomas Westfeld
I suppose that some of the intended changes are missing in the final commit. I'm going to add the label at the most plausible location. You may want to check that there are no other missing pieces.
comment:6 by , 13 years ago
Resolution: | → fixed |
---|---|
Status: | reopened → closed |
Working with sphinx implies to get the code and look at the docs directory.
But the patch LGTM.