[
https://issues.apache.org/jira/browse/SOLR-15265?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17304489#comment-17304489
]
Dawid Weiss commented on SOLR-15265:
------------------------------------
Hi Chris. It's all quite simple... but not straightforward for a newcomer. I
can tell you it takes a good few months to grasp the overall design and
structure of a gradle build (but then all the pieces do fall into place and
make sense).
The patch looks good. I think an improvement for later should be centered here:
{code:java}
// NOTE: extra '../' because we'll in a sub-dir of buildDir that will be built
later...
props: [
htmlSolrJavadocs : 'link:../' +
buildDir.toPath().relativize(project(':solr:documentation').docroot.toPath()).toString().replace(File.separator,
'/'),
- // TODO: This isn't viable long term - see SOLR-15262 / SOLR-15264
- htmlLuceneJavadocs :
"https://lucene.apache.org/core/${solrGuideVersionPath}_0/";
+ htmlLuceneJavadocs : 'link:../' +
buildDir.toPath().relativize(project(':solr:documentation').luceneDocsDir.toPath()).toString().replace(File.separator,
'/'), {code}
Ref guide build should really depend on those javadocs it links to - then there
would be no awkwardness and, ideally, you could just sync the resources you
need into the final structure (that's why I declared javadocs as an artifact).
This does entail some duplication (syncing between folders) but if it's reused
in different places then it's fine. If these javadocs are consumed by the ref
guide only, then I'd move those tasks to the ref guide itself - then they'd
live in the same project build.
But these improvements can come later. As Mike says - progress, not
perfection...
> 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)
