[jira] [Commented] (SOLR-12134) validate links to javadocs in ref-guide & hook all ref-guide validation into top level documentation/precommit

["Cassandra Targett (JIRA)" <ji...@apache.org>]

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

Cassandra Targett commented on SOLR-12134:
------------------------------------------

I'm finally getting around to reviewing this.

I applied the patch and ran several build-related commands (precommit, documentation, etc.). I also used the Ref Guide's {{ant default -Dlocal.javadocs=true}}, and had it in my head it would build the javadocs as part of it and it didn't so it failed ALL the javadoc checking, which I'm glad about in retrospect.

I think removing the PDF build from precommit and documentation targets was the right call - it does take a while and adding 5-10 minutes for something most people don't need as the output was a lot.

I've been trying to think of things missing or reasons not to do this as implemented, but can't. So +1 from me.

> validate links to javadocs in ref-guide & hook all ref-guide validation into top level documentation/precommit
> --------------------------------------------------------------------------------------------------------------
>
>                 Key: SOLR-12134
>                 URL: https://issues.apache.org/jira/browse/SOLR-12134
>             Project: Solr
>          Issue Type: Improvement
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation
>            Reporter: Hoss Man
>            Assignee: Hoss Man
>            Priority: Major
>         Attachments: SOLR-12134.patch, SOLR-12134.patch, nocommit.SOLR-12134.sample-failures.patch
>
>
> We've seen a couple problems come up recently where the ref-guide had broken links ot javadocs.
> In some cases these are because people made typos in java classnames / pathnames while editing the docs - but in other cases the problems were that the docs were correct at one point, but then later the class was moved/renamed/removed, or had it's access level downgraded from public to private (after deprecation)
> I've worked up a patch with some ideas to help us catch these types of mistakes - and in general to hook the "bare-bones HTML" validation (which does not require jekyll or any non-ivy managed external dependencies) into {{ant precommit}}
> Details to follow in comment/patch...



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

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org