Code

Opened 7 years ago

Closed 7 years ago

#3333 closed (fixed)

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

Reported by: adrian Owned by: jacob
Component: Documentation Version: master
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: UI/UX:

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 7 years ago.
3333-db-api.diff (1.1 KB) - added by ramiro <rm0 _at_ gmx.net> 7 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 7 years ago by SmileyChris

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

Changed 7 years ago by jacob

comment:2 Changed 7 years ago by SmileyChris

  • Triage Stage changed from Accepted to Ready for checkin

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

comment:3 Changed 7 years ago by adrian

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

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

comment:4 Changed 7 years ago 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.

Changed 7 years ago by ramiro <rm0 _at_ gmx.net>

comment:5 Changed 7 years ago by Ramiro Morales <rm0 _at_ gmx.net>

  • Resolution fixed deleted
  • Status changed from closed to reopened

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

comment:6 Changed 7 years ago by mtredinnick

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

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

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.