[ARTEMIS-1729] Automatically check for broken documentation links

• Type: Wish
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.34.0
• Component/s: Documentation
• Assignee: Justin Bertram
• Reporter: Lionel Cons
• Created: 05/Mar/18 08:49
• Updated: 29/May/24 15:15
• Resolved: 29/May/24 14:56

Description

The Artemis GitBook documentation sometimes contains broken (internal) links. See for instance ARTEMIS-1076 or ARTEMIS-1721.

It would be good to automatically check for broken links as part of the Maven test task.

One way to do this would be to have a Maven task to run a webserver serving the generated documentation (Python can trivially do it with 'python -m SimpleHTTPServer 8000' but an equivalent Java-based solution is probably better) and then a crawler checking for broken links (wget can easily be used for this as described in ARTEMIS-1076 but here again a Java-based solution is maybe better).

Issue Links

• links to: GitHub Pull Request #4882