Details
-
Question
-
Status: Closed
-
Major
-
Resolution: Information Provided
-
None
-
None
-
None
Description
This task is here to discuss how we might improve the documentation.
I recently ran linkcheck from my home system on the production site. There were a number of links with issues. I tried to run against the staging site but the robots.txt prohibited that.
I am wondering if there is a way to have the build system run a link check after the docs are generated to ensure that there are no broken links.
I think there are maven tools that will do some other testing (e.g. license checks, java doc checks) but much of the documentation is in markdown not html so testing may have to be done on the site after staging deployment.