RFR: JDK-8251210: Link JDK api docs to other versions

classic Classic list List threaded Threaded
6 messages Options
Reply | Threaded
Open this post in threaded view
|

RFR: JDK-8251210: Link JDK api docs to other versions

Jonathan Gibbons-2
Please review a small change to Docs.gmk, such that the short version string in the upper right corner of the main API docs bundle is linked to a page that links to other versions of the documentation.  While it is not so useful in this release, to be able to access _older_ versions, going forward, this will simplify the ability to get to _newer_ versions when search engines take you to the docs for an older release.

-------------

Commit messages:
 - JDK-8251210: Link JDK api docs to other versions

Changes: https://git.openjdk.java.net/jdk/pull/2854/files
 Webrev: https://webrevs.openjdk.java.net/?repo=jdk&pr=2854&range=00
  Issue: https://bugs.openjdk.java.net/browse/JDK-8251210
  Stats: 10 lines in 2 files changed: 9 ins; 0 del; 1 mod
  Patch: https://git.openjdk.java.net/jdk/pull/2854.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/2854/head:pull/2854

PR: https://git.openjdk.java.net/jdk/pull/2854
Reply | Threaded
Open this post in threaded view
|

Re: RFR: JDK-8251210: Link JDK api docs to other versions

liach
On Sat, 6 Mar 2021 02:21:00 GMT, Jonathan Gibbons <[hidden email]> wrote:

> Please review a small change to Docs.gmk, such that the short version string in the upper right corner of the main API docs bundle is linked to a page that links to other versions of the documentation.  While it is not so useful in this release, to be able to access _older_ versions, going forward, this will simplify the ability to get to _newer_ versions when search engines take you to the docs for an older release.

Does this change add the "other versions" text under the current version info? I don't see where the `Other Versions` text (proposed in the original issue) is added.

-------------

PR: https://git.openjdk.java.net/jdk/pull/2854
Reply | Threaded
Open this post in threaded view
|

Re: RFR: JDK-8251210: Link JDK api docs to other versions

Jonathan Gibbons-2
On Sat, 6 Mar 2021 13:13:02 GMT, liach <[hidden email]> wrote:

> Does this change add the "other versions" text under the current version info? I don't see where the `Other Versions` text (proposed in the original issue) is added. Without that text, imo this utility would be significantly less accessible, as not many people would know this trick by looking at this pull request, the original JDK issue, or by inspecting the html.

No, after offline discussions, we decided to just link the existing text for the short version string, to minimize the disruption to the header. This opens up the possibility of applying a similar change to modify existing published docs in a similar manner, which is the more interesting case.

-------------

PR: https://git.openjdk.java.net/jdk/pull/2854
Reply | Threaded
Open this post in threaded view
|

Re: RFR: JDK-8251210: Link JDK api docs to other versions

Iris Clark-4
In reply to this post by Jonathan Gibbons-2
On Sat, 6 Mar 2021 02:21:00 GMT, Jonathan Gibbons <[hidden email]> wrote:

> Please review a small change to Docs.gmk, such that the short version string in the upper right corner of the main API docs bundle is linked to a page that links to other versions of the documentation.  While it is not so useful in this release, to be able to access _older_ versions, going forward, this will simplify the ability to get to _newer_ versions when search engines take you to the docs for an older release.

Marked as reviewed by iris (Reviewer).

-------------

PR: https://git.openjdk.java.net/jdk/pull/2854
Reply | Threaded
Open this post in threaded view
|

Re: RFR: JDK-8251210: Link JDK api docs to other versions

Erik Joelsson-2
In reply to this post by Jonathan Gibbons-2
On Sat, 6 Mar 2021 02:21:00 GMT, Jonathan Gibbons <[hidden email]> wrote:

> Please review a small change to Docs.gmk, such that the short version string in the upper right corner of the main API docs bundle is linked to a page that links to other versions of the documentation.  While it is not so useful in this release, to be able to access _older_ versions, going forward, this will simplify the ability to get to _newer_ versions when search engines take you to the docs for an older release.

Marked as reviewed by erikj (Reviewer).

-------------

PR: https://git.openjdk.java.net/jdk/pull/2854
Reply | Threaded
Open this post in threaded view
|

Integrated: JDK-8251210: Link JDK api docs to other versions

Jonathan Gibbons-2
In reply to this post by Jonathan Gibbons-2
On Sat, 6 Mar 2021 02:21:00 GMT, Jonathan Gibbons <[hidden email]> wrote:

> Please review a small change to Docs.gmk, such that the short version string in the upper right corner of the main API docs bundle is linked to a page that links to other versions of the documentation.  While it is not so useful in this release, to be able to access _older_ versions, going forward, this will simplify the ability to get to _newer_ versions when search engines take you to the docs for an older release.

This pull request has now been integrated.

Changeset: b1cc864a
Author:    Jonathan Gibbons <[hidden email]>
URL:       https://git.openjdk.java.net/jdk/commit/b1cc864a
Stats:     10 lines in 2 files changed: 9 ins; 0 del; 1 mod

8251210: Link JDK api docs to other versions

Reviewed-by: iris, erikj

-------------

PR: https://git.openjdk.java.net/jdk/pull/2854