8294074: Make other specs more discoverable from the API docs

[hns]

Please review a doc-only change to the API overview page to make other specs more discoverable. The following sentence is added at the end of the overview text:

Related documents specify the Java language, the Java virtual machine, various protocols and file formats pertaining to the Java platform, and tools included in the JDK.

The first sentence of the overview text is also rephrased.

The new API overview page can be viewed here.

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8294074: Make other specs more discoverable from the API docs (Enhancement - P3)

Reviewers

• Mark Reinhold (@mbreinhold - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/26547/head:pull/26547
$ git checkout pull/26547

Update a local copy of the PR:
$ git checkout pull/26547
$ git pull https://git.openjdk.org/jdk.git pull/26547/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 26547

View PR using the GUI difftool:
$ git pr show -t 26547

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/26547.diff

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@hns This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8294074: Make other specs more discoverable from the API docs

Reviewed-by: mr

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 37 new commits pushed to the master branch:

• c4fbfa2: 8363949: Incorrect jtreg header in MonitorWithDeadObjectTest.java
• 1b9efaa: 8364183: Shenandoah: Improve commit/uncommit handling
• b2b56cf: 8359395: XML signature generation does not support user provided SecureRandom
• ... and 34 more: https://git.openjdk.org/jdk/compare/965b68107ffe1c1c988d4faf6d6742629407451b...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[openjdk]

@hns The following label will be automatically applied to this pull request:

• build

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 02: Full - Incremental (e96c73da)
• 01: Full - Incremental (7f038dea)
• 00: Full (2c7236d8)

[AlanBateman]

@hns Is this wording that is agreed elsewhere or are you open to suggestions on how this should be worded?

[hns]

This wording is what we came up with in internal discussion, but certainly open to suggestions. I created this PR to make the process more transparent.

[irisclark]

Minimally, I would not refer to the narrative specs which are part of the platform as "Related documents" since that makes them sound weakly advisory/informational. Perhaps something like "[Additional specifications][../specs/index.html] for the Java language...".

Also, if you're going to provide a link to the narrative specs, I'd also consider adding a reference to the external spec page (https://download.java.net/java/early_access/jdk25/docs/api/external-specs.html).

[mbreinhold]

The first word after “related documents” is “specify,” which doesn’t sound advisory to me.

I don’t think the external spec page is of sufficiently broad interest to highlight it here.

(To imply that our tool man pages are “specifications” is a bit much, but making that distinction isn’t worth the trouble here.)

[rose00]

TIL about that external spec page. Thanks!

[hns]

/integrate

[openjdk]

Going to push as commit 7d63c9f.
Since your change was applied there have been 48 commits pushed to the master branch:

• beda14e: 8364423: G1: Refactor G1UpdateRegionLivenessAndSelectForRebuildTask
• ae11d8f: 8364248: Separate commit and reservation limit detection
• e82d7f5: 8364351: ZGC: Replace usages of ZPageAgeRange() with ZPageAgeRangeAll
• ... and 45 more: https://git.openjdk.org/jdk/compare/965b68107ffe1c1c988d4faf6d6742629407451b...master

Your commit was automatically rebased without conflicts.

[openjdk]

@hns Pushed as commit 7d63c9f.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.