You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Hoss Man (JIRA)" <ji...@apache.org> on 2018/03/21 17:05:00 UTC
[jira] [Updated] (SOLR-12134) validate links to javadocs in
ref-guide & hook all ref-guide validation into top level
documentation/precommit
[ https://issues.apache.org/jira/browse/SOLR-12134?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Hoss Man updated SOLR-12134:
----------------------------
Attachment: nocommit.SOLR-12134.sample-failures.patch
SOLR-12134.patch
> 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, 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