[
https://issues.apache.org/jira/browse/LUCENE-9321?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17099752#comment-17099752
]
Uwe Schindler edited comment on LUCENE-9321 at 5/5/20, 10:19 AM:
-----------------------------------------------------------------
bq. There's one thing I'm not fully understand. According to this policy, how
do we handle links in Solr javadocs to Lucene javadocs. To be strictly
consistent, those should be relative links for website, but absolute links for
tar.gz (because Lucene and Solr archives are separately distributed). ?
Sorry for not having a full answer to this on the weekend. The proposal to
split Lucene and Solr on the development mailinglist was something I did not
want to make public.
With that background, I can now confirm my previous statements:
- If solr splits off lucene, the links between both projects need to be
absolute anyways. Or - removed alltogether from Javadocs, as it's to fragile
- The recent changes also confirm my previous problem with absolute links: Once
projects split, the current Javadoc repository needs to be moved possibly to
another *.apache.org subdomain. Of course we will have redirects, but
nevertheless I don't want to introduce a redirect for every link anywhere in
the Javadocs. So relative links that link between modules of Solr and/or Lucene
should be relative, otherwise it's a nightmare to maintain afterwards.
These two reasons are my main arguments for having only relative links between
modules in the "overall documentation". For individual Maven artifacts I don't
care, but there the links should be absolute (with configurable location) or
removed altogether. Somebody using the "javadoc" maven artifact just needs docs
for the current method heshe is looking at, so we could possibly also remove
all links there.
was (Author: thetaphi):
bq. There's one thing I'm not fully understand. According to this policy, how
do we handle links in Solr javadocs to Lucene javadocs. To be strictly
consistent, those should be relative links for website, but absolute links for
tar.gz (because Lucene and Solr archives are separately distributed). ?
Sorry for not having a full answer to this on the weekend. The proposal to
split Lucene and Solr on the development mailinglist was something I did not
want to make publish.
With that background, I can now confirm my previous statements:
- If solr splits off lucene, the links between both projects need to be
absolute anyways. Or - removed alltogether from Javadocs, as it's to fragile
- The recent changes also confirm my previous problem with absolute links: Once
projects split, the current Javadoc repository needs to be moved possibly to
another *.apache.org subdomain. Of course we will have redirects, but
nevertheless I don't want to introduce a redirect for every link anywhere in
the Javadocs. So relative links that link between modules of Solr and/or Lucene
should be relative, otherwise it's a nightmare to maintain afterwards.
These two reasons are my main arguments for having only relative links between
modules in the "overall documentation". For individual Maven artifacts I don't
care, but there the links should be absolute (with configurable location) or
removed altogether. Somebody using the "javadoc" maven artifact just needs docs
for the current method heshe is looking at, so we could possibly also remove
all links there.
> Port documentation task to gradle
> ---------------------------------
>
> Key: LUCENE-9321
> URL: https://issues.apache.org/jira/browse/LUCENE-9321
> Project: Lucene - Core
> Issue Type: Sub-task
> Components: general/build
> Reporter: Tomoko Uchida
> Assignee: Uwe Schindler
> Priority: Major
> Fix For: master (9.0)
>
> Attachments: screenshot-1.png
>
> Time Spent: 2.5h
> Remaining Estimate: 0h
>
> This is a placeholder issue for porting ant "documentation" task to gradle.
> The generated documents should be able to be published on lucene.apache.org
> web site on "as-is" basis.
--
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
