thymeleaf / thymeleaf-docs

Thymeleaf documentation
Apache License 2.0
44 stars 54 forks source link

A few dead links in docs and articles #46

Closed vkuzel closed 7 years ago

vkuzel commented 7 years ago

I discovered some dead links in docs and articles. I actually crawled the site to find them. Btw. there are ton of dead links in forum but it's probably not worth fixing.

On page: http://www.thymeleaf.org/doc/articles/layouts.html Are dead links pointing to:

On page: http://www.thymeleaf.org/download.html Is dead link:

On page: http://www.thymeleaf.org/apidocs/thymeleaf/2.1.3.RELEASE/org/thymeleaf/dom/Node.NodeLocalVariablesMap.html Are dead links:

On page: http://www.thymeleaf.org/ecosystem.html Is dead link:

On page: http://www.thymeleaf.org/apidocs/thymeleaf/3.0.3.RELEASE/org/thymeleaf/util/FastStringWriter.html Is dead link:

On page: http://www.thymeleaf.org/apidocs/thymeleaf/3.0.3.RELEASE/org/thymeleaf/templateparser/reader/PrototypeOnlyCommentTextReader.html#PrototypeOnlyCommentTextReader-java.io.Reader- Is dead link:

On page: http://www.thymeleaf.org/whatsnew21.html#spconv Is dead link:

ultraq commented 7 years ago

Thanks for letting us know @vkuzel! I'll update the ones that cross into the website too and are not generated from this project.

Note to myself:

On page: http://www.thymeleaf.org/doc/articles/layouts.html Are dead links pointing to:

These will be taken care by #42, so don't do anything about them.

ultraq commented 7 years ago

Reformatted with checkboxes so I can mark ones as done:


On page: http://www.thymeleaf.org/doc/articles/layouts.html

On page: http://www.thymeleaf.org/download.html

On page: http://www.thymeleaf.org/apidocs/thymeleaf/2.1.3.RELEASE/org/thymeleaf/dom/Node.NodeLocalVariablesMap.html

On page: http://www.thymeleaf.org/ecosystem.html

On page: http://www.thymeleaf.org/apidocs/thymeleaf/3.0.3.RELEASE/org/thymeleaf/util/FastStringWriter.html

On page: http://www.thymeleaf.org/apidocs/thymeleaf/3.0.3.RELEASE/org/thymeleaf/templateparser/reader/PrototypeOnlyCommentTextReader.html#PrototypeOnlyCommentTextReader-java.io.Reader-

On page: http://www.thymeleaf.org/whatsnew21.html#spconv

ultraq commented 7 years ago

@danielfernandez, the unticked javadoc items above have revealed something interesting. Those links are actually for higher versions of Java SE than what that version of Thymeleaf supports, eg: the Thymeleaf 2 doc is trying to link to an item that wasn't added until Java 6.

I've taken a look at our code and I don't think it's doing anything wrong, so it still properly supports the Java versions we say, but I suspect the problem is with maven-javadoc-plugin in that it's autodetecting the JDK on the machine to build the available links but somewhere else is then using the lower Java version's base URL. I dunno.

danielfernandez commented 7 years ago

Note those are for Thymeleaf 2.1.3 (a quite old version -- May 2014), and Thymeleaf 2.1 was Java 5 compatible, not Java 6. So it's normal that it links to the 1.5.0 javadoc.

BUT note that even if 2.1.3 is Java5-source-compatible, its binaries and javadoc were built using Java 6. And the latest version of that branch, 2.1.5, using Java 8. Still, links are pointing to 1.5.0 because the "source" property of maven-compiler-plugin says the source is compatible with 1.5.0.

So, what happens? Well, what happens is that the javadoc tools for versions 6 or 8 determine that those classes inherit those interfaces, because that's what happens in v6/v8's runtimes. And create the links using the base URL for 1.5.0. Which fails, because in 1.5.0 those interfaces didn't exist.

So it's an interaction between the maven-javadoc-plugin and the javadoc tool itself. I wouldn't worry at all about something like this.

ultraq commented 7 years ago

Cool, if you're not worried about those, then I'm going to consider this one done.

danielfernandez commented 7 years ago

Emanuel, these fixes... did you have to apply any changes on thymeleaf-dist? I don't find any new commits there…

ultraq commented 7 years ago

The only commits related to this were on the website project: https://github.com/thymeleaf/thymeleaf.github.com/commit/7287d771163eff6a8c8aa2c6cbc260f09411f048 Even then they were for our "obsolete" "What's New?" pages. The rest had been fixed since the issue was reported.