Opened 7 years ago

Closed 7 years ago

Last modified 4 years ago

#8701 closed (fixed)

Fix references to old doc

Reported by: julien Owned by: jacob
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

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)

8701.diff (3.8 KB) - added by thejaswi_puthraya 7 years ago.
removed many documented references, few more to go
8701-v2.diff (9.3 KB) - added by richardb 7 years ago.
Another patch; more complete.
8701.couple-more-old-doc-refs.diff (871 bytes) - added by julien 7 years ago.

Download all attachments as: .zip

Change History (18)

Changed 7 years ago by thejaswi_puthraya

removed many documented references, few more to go

comment:1 Changed 7 years ago by thejaswi_puthraya

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

Some references still exist to topics like abstract base classes, multi-table inheritance which have not been documented in the new docs.

comment:2 Changed 7 years ago by thejaswi_puthraya

#8533 has the list of undocumented features.

comment:3 Changed 7 years ago by patrickf

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 Changed 7 years ago by richardb

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 Changed 7 years ago by richardb

  • Owner changed from nobody to richardb

Changed 7 years ago by richardb

Another patch; more complete.

comment:6 follow-up: Changed 7 years ago by richardb

  • 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 in reply to: ↑ 6 Changed 7 years ago by julien

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 Changed 7 years ago by richardb

  • Owner richardb deleted

comment:9 Changed 7 years ago by jacob

  • Resolution set to fixed
  • Status changed from new to closed

(In [8857]) Cleaned up a bunch of minor doc stuff:

  • Removed flatpages/redirects README; no other contrib apps have those.
  • Cleaned up top-level README to be more readable.
  • Removed outdated references to old docs (Fixes #8701)

Changed 7 years ago by julien

comment:10 Changed 7 years ago by julien

  • Resolution fixed deleted
  • Status changed from closed to 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 Changed 7 years ago by jacob

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 Changed 7 years ago by jacob

  • Owner set to jacob
  • Status changed from reopened to new

comment:13 Changed 7 years ago by jacob

  • Status changed from new to assigned

comment:14 Changed 7 years ago by jacob

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [8941]) Fixed #8701, a couple of bad links in the docs.

comment:15 Changed 4 years ago by jacob

  • milestone 1.0 deleted

Milestone 1.0 deleted

Note: See TracTickets for help on using tickets.
Back to Top