Django

Code

Ticket #3333 (closed: fixed)

Opened 2 years ago

Last modified 1 year ago

Documentation should use relative links, not hard-coded djangoproject.com links

Reported by: adrian Assigned to: jacob
Milestone: Component: Documentation
Version: SVN Keywords:
Cc: smileychris+django@gmail.com Triage Stage: Ready for checkin
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

As suggested in this django-developers thread, every document in our docs directory should have its http://www.djangoproject.com/documentation/ links converted to relative links. This will make it easier for people to view documentation as HTML locally (see #528) and will solve the problem of old documentation linking to new documentation.

I made an example change in [4358].

Attachments

relative_doc_paths.diff (55.8 kB) - added by jacob on 01/19/07 13:56:57.
3333-db-api.diff (1.1 kB) - added by ramiro <rm0 _at_ gmx.net> on 01/27/07 08:18:03.

Change History

01/19/07 12:59:19 changed by SmileyChris

  • cc set to smileychris+django@gmail.com.
  • has_patch set to 1.

I have a ticket ready with this all in it. When trac accepts tickets again I'll put it in.

Any instances of the absolute URL that I left were references to the online version (or examples of links).

01/19/07 13:56:57 changed by jacob

  • attachment relative_doc_paths.diff added.

01/24/07 13:57:20 changed by SmileyChris

  • stage changed from Accepted to Ready for checkin.

Thanks, jacob. Don't know why it wouldn't upload for me...

01/24/07 18:54:19 changed by adrian

  • status changed from new to closed.
  • resolution set to fixed.

(In [4420]) Fixed #3333 -- Docs now use relative links, not hard-coded djangoproject.com links. Thanks for the patch, SmileyChris?

01/27/07 08:16:50 changed by ramiro <rm0 _at_ gmx.net>

Please consider reopening this ticket and applying the attached patch that modifies the links in the db-api documentation so they are relative. It was missed in the original patch.

01/27/07 08:18:03 changed by ramiro <rm0 _at_ gmx.net>

  • attachment 3333-db-api.diff added.

02/28/07 16:19:14 changed by Ramiro Morales <rm0 _at_ gmx.net>

  • status changed from closed to reopened.
  • resolution deleted.

developers won't know about the mini-patch if they don't see it the ticket reopened, so here we go...

03/08/07 02:50:33 changed by mtredinnick

  • status changed from reopened to closed.
  • resolution set to fixed.

(In [4681]) Fixed #3333 -- Made db-api.txt links relative, in line with the other docs. Thanks, Ramiro Morales.


Add/Change #3333 (Documentation should use relative links, not hard-coded djangoproject.com links)




Change Properties
Action