Troubles with java11 docs
Martin Buchholz
martinrb at google.com
Thu Sep 27 01:47:42 UTC 2018
I was trying to migrate to using the shiny
https://docs.oracle.com/en/java/javase/11/
for all my documentation needs and ran into some troubles:
Every year I complain about no one checking for dead links in the docs.
Running a dead-link checker before a major release should be easy-peasy.
E.g. in
https://docs.oracle.com/en/java/javase/11/docs/specs/jdwp/jdwp-protocol.html
I see a link to
https://docs.oracle.com/en/java/javase/11/api/java/lang/ThreadGroup.html
but that's a 404 ... because ... there's now a new level in the api
docs hierarchy
The actual link is
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ThreadGroup.html
so this URL is broken in two different ways.
Including module names in the api docs hierarchy makes some sense, but
then how to reconcile with the javadoc flags -Xdocrootparent and
-link, which can only take a single URL?
The link
https://docs.oracle.com/javase/11/docs/api/java/util/ArrayList.html
shouldn't be a 404
I'm finding it hard to generate private javadoc with external links to
java 11 javadoc on docs.oracle.com
I'm surprised that visiting
https://docs.oracle.com/javase/11/docs
redirects to the top-level doc page
https://docs.oracle.com/en/java/javase/11/
but
https://docs.oracle.com/en/java/javase/11/docs
redirects to the API
https://docs.oracle.com/en/java/javase/11/docs/api/index.html
even though specs are stored under
https://docs.oracle.com/en/java/javase/11/docs/specs/
e.g.
https://docs.oracle.com/en/java/javase/11/docs/specs/jvmti.html
but visiting
https://docs.oracle.com/en/java/javase/11/docs/specs/
also gives an unexpected 404
I was surprised to not be able to find the JDWP spec by clicking
around from https://docs.oracle.com/en/java/javase/11/
but the search box on that page worked!
More information about the web-discuss
mailing list