[jira] [Updated] (SOLR-15265) decide if/how to validate lucene javadoc links

["Chris M. Hostetter (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/SOLR-15265?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Chris M. Hostetter updated SOLR-15265:
--------------------------------------
    Attachment: SOLR-15265.patch
      Assignee: Chris M. Hostetter
        Status: Open  (was: Open)

{quote}Hi Chris. I added a PR showing how to fetch Lucene javadocs as maven artifacts and unpack them locally. This should be enough to validate links, I think (but I didn't take it any further).
{quote}
Yes! ... absolutely – thank you very much for this! (I don't want to guess about how long it would have taken me to figure out the 'classifier' option on the dependencies; and/or using the resolvedConfiguration/resolvedArtifacts to access the files programmatically)

I'm attaching a patch that builds on yours:
 * tweaked the task & artifact names to "collectLuceneJavadocs" & "luceneDocsDir" make it clear this is just dealing with lucene javadocs (not solr javadocs, nor any other third-party deps)
 * expanded the list of jars to cover everything (currently) needed by ref-guide
 * changed the strcuture o how the jars get unzipped in the "luceneDocsDir" to match how Lucene's "documentation" tasks arrange them for hosting on lucene.apache.org (since we need to mimic that for validating that our links will point hte correct places on release)
 * updated the ref-guide build.gradle to use "luceneDocsDir" in the checkLocalJavadocLinksSite task.

WDYT?

> decide if/how to validate lucene javadoc links
> ----------------------------------------------
>
>                 Key: SOLR-15265
>                 URL: https://issues.apache.org/jira/browse/SOLR-15265
>             Project: Solr
>          Issue Type: Sub-task
>      Security Level: Public(Default Security Level. Issues are Public) 
>            Reporter: Chris M. Hostetter
>            Assignee: Chris M. Hostetter
>            Priority: Major
>         Attachments: SOLR-15265.patch
>
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> From parent issue...
> {quote}
> come up with a longer term plan for if/how we want to "validate" links to lucene javadocs
> * we currently don't do any validation of links to "remote" urls in the ref-guide content – regardless of wether they are hardcoded or version specific via ivy properties
> * we may want to revisit that now ... either in general, or via some lucene specific logic (possibly via fetching lucene src or javadoc jars) since we have so many links to lucene class javadocs
> {quote}



--
This message was sent by Atlassian Jira
(v8.3.4#803005)