Opened 18 years ago

Closed 18 years ago

#3333 closed (fixed)

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

Reported by: Adrian Holovaty Owned by: Jacob
Component: Documentation Version: dev
Severity: Keywords:
Cc: smileychris+django@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

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 (2)

relative_doc_paths.diff​ (55.8 KB ) - added by Jacob 18 years ago.
3333-db-api.diff​ (1.1 KB ) - added by ramiro <rm0 _at_ gmx.net> 18 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 by Chris Beaven, 18 years ago

Cc: smileychris+django@… added
Has patch: set

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).

by Jacob, 18 years ago

Attachment: relative_doc_paths.diff​ added

comment:2 by Chris Beaven, 18 years ago

Triage Stage: Accepted → Ready for checkin

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

comment:3 by Adrian Holovaty, 18 years ago

Resolution: → fixed
Status: new → closed

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

comment:4 by ramiro <rm0 _at_ gmx.net>, 18 years ago

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.

by ramiro <rm0 _at_ gmx.net>, 18 years ago

Attachment: 3333-db-api.diff​ added

comment:5 by Ramiro Morales <rm0 _at_ gmx.net>, 18 years ago

Resolution: fixed
Status: closed → reopened

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

comment:6 by Malcolm Tredinnick, 18 years ago

Resolution: → fixed
Status: reopened → closed

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

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