[
https://issues.apache.org/jira/browse/LUCENE-9278?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17059975#comment-17059975
]
Tomoko Uchida commented on LUCENE-9278:
---------------------------------------
Just to clarify the situation here... we have two types of relative paths
(inter-module links).
1) "hard-coded" relative paths which exist in Javadoc description.
e.g.:
[https://lucene.apache.org/core/8_4_1/core/org/apache/lucene/analysis/Analyzer.html]
At least {{Analyzer}} class has this type of links. Not sure there are other
same kind of links.
We cannot modify them until we stop using Ant for generating javadocs. Also, I
don't see any way to convert them to absolute urls (for now), so just rewrite
the paths after switching Gradle to avoid broken links. (We may have to remove
those hand crafted links from javadocs and figure out better ways to refer
another module from "core", but it should be considered on another issue.)
2) Auto generated relative paths by {{<link href="...">}} element of Ant
javadoc task.
e.g.:
[https://lucene.apache.org/core/8_4_1/analyzers-icu/org/apache/lucene/analysis/icu/ICUFoldingFilterFactory.html]
I believe we can change all of them to absolute urls from the gradle build,
just as Solr docs refers to Lucene docs
([https://lucene.apache.org/solr/8_4_1/solr-core/org/apache/solr/analysis/ReversedWildcardFilter.html])
but have not yet tried. We can start to work for that from now on because it's
all about gradle build and does not have any effect to ant (I think).
Please let me know if I'm missing something.
> Make javadoc folder structure follow Gradle project path
> --------------------------------------------------------
>
> Key: LUCENE-9278
> URL: https://issues.apache.org/jira/browse/LUCENE-9278
> Project: Lucene - Core
> Issue Type: Task
> Components: general/build
> Reporter: Tomoko Uchida
> Priority: Major
> Time Spent: 1.5h
> Remaining Estimate: 0h
>
> Current javadoc folder structure is derived from Ant project name. e.g.:
> [https://lucene.apache.org/core/8_4_1/analyzers-icu/index.html]
> [https://lucene.apache.org/solr/8_4_1/solr-solrj/index.html]
> For Gradle build, it should also follow gradle project structure (path)
> instead of ant one, to keep things simple to manage [1]. Hence, it will look
> like this:
> [https://lucene.apache.org/core/9_0_0/analysis/icu/index.html]
> [https://lucene.apache.org/solr/9_0_0/solr/solrj/index.html]
> [1] The change was suggested at the conversation between Dawid Weiss and I on
> a github pr: [https://github.com/apache/lucene-solr/pull/1304]
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
