https://dev.arvados.org/https://dev.arvados.org/favicon.ico?15576888422014-04-02T13:02:10ZArvadosArvados - Feature #2509: doc: make rake linkchecker task and describe in readmehttps://dev.arvados.org/issues/2509?journal_id=91882014-04-02T13:02:10ZWard Vandewegeward@curii.com
<ul><li><strong>Assigned To</strong> set to <i>Ward Vandewege</i></li></ul> Arvados - Feature #2509: doc: make rake linkchecker task and describe in readmehttps://dev.arvados.org/issues/2509?journal_id=91912014-04-02T13:56:37ZBrett Smithbrett.smith@curii.com
<ul></ul><p>Thanks for adding this. I love being able to do more tests locally—it means fewer bad builds on Jenkins. :)</p>
<p>The new h2 in README is numbered 2, duplicating the h2 after it. IMO we should just remove all the numbering.</p>
<p>As a general point of code hygiene, I think it'd be good to pass a block to Dir.chdir that does the linkchecker call. That avoids snagging future developers with the different working directory.</p>
<p><code>--ignore-url</code> takes a regular expression. Could we better anchor the patterns that are meant to catch schemes, like <code>^mailto:</code> and <code>^javascript:</code>? That could help avoid ignoring links we shouldn't—I think <code>javascript</code> especially could generate false negatives. For external hosts, we could probably match against <code>\bhostname\.tld(/|$)</code>.</p>
<p>Is there any particular rhyme or reason to which external hosts are ignored? If it's supposed to be "all of them," I think it will save us maintenance time in the long run if we figure out a way to dynamically generate this list. I don't think it has to be perfect, just something that's good enough to avoid a requirement to add hostnames to the list when we add links. (I'm a little surprised and annoyed that linkchecker doesn't have a switch like --dont-visit-other-hosts, but them's the breaks.)</p> Arvados - Feature #2509: doc: make rake linkchecker task and describe in readmehttps://dev.arvados.org/issues/2509?journal_id=92072014-04-03T15:20:39ZBrett Smithbrett.smith@curii.com
<ul></ul><p>Updated version looks great to me. I say merge it. Thanks again.</p> Arvados - Feature #2509: doc: make rake linkchecker task and describe in readmehttps://dev.arvados.org/issues/2509?journal_id=92112014-04-03T15:42:09ZWard Vandewegeward@curii.com
<ul><li><strong>Status</strong> changed from <i>New</i> to <i>Resolved</i></li></ul>