#8701 closed (fixed)
Fix references to old doc
Reported by: | Julien Phalip | Owned by: | Jacob |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Keywords: | ||
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
I've counted 33 references to the old doc (http://www.djangoproject.com/documentation), either in the code or in the refactored doc.
Those should be fixed before release.
Attachments (3)
Change History (18)
by , 16 years ago
comment:1 by , 16 years ago
Triage Stage: | Unreviewed → Accepted |
---|
Some references still exist to topics like abstract base classes, multi-table inheritance which have not been documented in the new docs.
comment:3 by , 16 years ago
hi thejaswi_puthraya, it appears that the patch that you submitted is... faulty. It is prefixed with a/ - so it cannot be applied cleanly.
Is this intentional, and are you intending to go through all of the documentation to clear out all the references to the old docs - as you have not done all yet?
Please advise - or join us on IRC - django-sprint...
thanks... patrickf
comment:4 by , 16 years ago
thejaswi_puthraya: it's worth checking http://www.djangoproject.com/documentation/contributing/#patch-style.
The 'standard' patch style uses svn diff. Your patch was probably created using mercurial/git (thanks cramm for that tip).
comment:5 by , 16 years ago
Owner: | changed from | to
---|
follow-up: 7 comment:6 by , 16 years ago
Has patch: | set |
---|
Added a new patch (8701-v2.diff).
This is a longer version of 8701.diff:
- found more references to old documentation location.
- I've left alone old-doc references to subjects missing in the new docs (ex: model inheritance).
#8533 covers this subject, changing the links from old doc to new doc should probably be part of a patch for that ticket.
I'm adding a comment to #8533 to remember this task.
- I've left alone links to 0.96 documentation, as I assume that its location is not changing.
Please correct me if I am wrong!
comment:7 by , 16 years ago
Replying to richardb:
- I've left alone links to 0.96 documentation, as I assume that its location is not changing.
Please correct me if I am wrong!
Yes, Jacob just confirmed that: "... the old docs will stay where they are; 1.0+ will be in the new place."
http://groups.google.com/group/django-developers/browse_thread/thread/8375d99c2216470f#
comment:8 by , 16 years ago
Owner: | removed |
---|
comment:9 by , 16 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
by , 16 years ago
Attachment: | 8701.couple-more-old-doc-refs.diff added |
---|
comment:10 by , 16 years ago
Resolution: | fixed |
---|---|
Status: | closed → reopened |
I spotted a couple more outdated references to the old docs. See the attached patch.
I think those are the last ones, excluding the references to the previous releases (0.95/0.96) and the model examples. Concerning the latter, I'm wondering if that's actually intentional. I've just asked the question on the dev-list: http://groups.google.com/group/django-developers/browse_thread/thread/2b6377bfe5e25170#
comment:11 by , 16 years ago
In the future please open new tickets in situations like this - it's easy for us to follow what's going on when we don't recycle closed tickets. I'll clean this up today, though; thanks for the patch.
comment:12 by , 16 years ago
Owner: | set to |
---|---|
Status: | reopened → new |
comment:13 by , 16 years ago
Status: | new → assigned |
---|
comment:14 by , 16 years ago
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
removed many documented references, few more to go