activemq-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Stanislav Knot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ARTEMIS-1729) Automatically check for broken documentation links
Date Tue, 06 Mar 2018 15:04:00 GMT

    [ https://issues.apache.org/jira/browse/ARTEMIS-1729?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16387907#comment-16387907
] 

Stanislav Knot commented on ARTEMIS-1729:
-----------------------------------------

I have noticed the issues with broken links are caused by renaming files, so I created script, which
parses file names and check if files exist. Sure, it would be better to have tool which checks
links.

 

If you think it is not useless: [https://pastebin.com/PDWN3QMz] (please ignore it's ugliness).

> Automatically check for broken documentation links
> --------------------------------------------------
>
>                 Key: ARTEMIS-1729
>                 URL: https://issues.apache.org/jira/browse/ARTEMIS-1729
>             Project: ActiveMQ Artemis
>          Issue Type: Bug
>            Reporter: Lionel Cons
>            Priority: Major
>
> 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).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message