Opened 6 years ago

Last modified 2 years ago

#16711 assigned enhancement

Tutorials: it would be useful to redirect to latest version just as it is done already for the reference guide

Reported by: Adrian Vasiliu Owned by: dylan
Priority: undecided Milestone: 1.15
Component: Website Version: 1.8.3
Keywords: Cc:
Blocked By: Blocking:

Description

For the reference guide, the site redirects URLs without Dojo version number to the latest release. For instance, http://dojotoolkit.org/reference-guide/dojo/on.html redirects to http://dojotoolkit.org/reference-guide/1.8/dojo/on.html . But this does not hold for tutorials. For instance, http://dojotoolkit.org/documentation/tutorials/modern_dojo/ gives "page not found" instead of redirecting to http://dojotoolkit.org/documentation/tutorials/1.8/modern_dojo/ .

Since the redirect doesn't work for tutorials, when writing a documentation (reference or tutorial) which wants to point to a tutorial, the link needs to include the version number, for instance in RST files of the reference guide:

.. _`Classy JavaScript with dojo/declare`: http://dojotoolkit.org/documentation/tutorials/1.7/declare/

Supporting a similar redirection mechanism for both reference guide and tutorials would make the documentation easier to maintain, avoiding the need to update the version numbers in the URLs. In particular, when writing new documentation for the next release (currently 1.9), you can't point to the 1.9 version of the tutorials as long as they don't exist yet, so you need to refer to the 1.8 and update it later...

Side-remark, in an ideal world it would be possible to use relative (not absolute) cross links between reference and tutorials. This would allow writing in the doc generic links (without version number), while ensuring for instance that a given version of the refguide points to the matching version of the tutorial.

Change History (5)

comment:1 Changed 6 years ago by dylan

Milestone: tbd1.9
Owner: changed from itorrey to dylan
Status: newassigned

This has bugged me for a while as well, though I've actually been inclined to go the other direction at times, and make the version very explicit (so that someone who is working with 1.8 doesn't get redirected to docs for 1.9).

That said, I do agree in the overall premise... if no version number is specified, redirect to the latest.

comment:2 Changed 6 years ago by Colin Snover

Milestone: 1.91.10

1.9 is released; moving remaining tickets to next milestone.

comment:3 Changed 5 years ago by dylan

Milestone: 1.101.11

comment:4 Changed 3 years ago by dylan

Milestone: 1.111.12

comment:5 Changed 2 years ago by dylan

Milestone: 1.131.15

Ticket planning... move current 1.13 tickets out to 1.15 to make it easier to move tickets into the 1.13 milestone.

Note: See TracTickets for help on using tickets.