You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by "Jan Høydahl (Jira)" <ji...@apache.org> on 2019/10/31 14:15:00 UTC
[jira] [Commented] (LUCENE-6257) Remove javadocs from releases
(except for publishing)
[ https://issues.apache.org/jira/browse/LUCENE-6257?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16964069#comment-16964069 ]
Jan Høydahl commented on LUCENE-6257:
-------------------------------------
Related to discussion in LUCENE-9014 about not hosting online java docs ourselves but relying on javadoc.io.
The docs/ folder of lucene-8.2.0.tgz is 7.4Mb of the 75Mb tarball. Unpacked it is 119Mb of 185Mb total. Number of files in archive is 7836 in docs/ folder and 214 other files.
So if we cut the java doc html from the tarball, we could provide a convenience script "download-javadoc.sh" to download the javadoc jars for offline use. Here's a toolchain that i just tested:
# Fetch all jars from maven repo using coursier fetch cli tool - [https://get-coursier.io/docs/cli-fetch] (apache licensed, just a few kb)
# unjar each -javadoc.jar into its own folder
# generate an "uber" index.html linking to each module's index.html (this uber index.html could optionally provide a top-nav frame for quick inter-module jumping)
> Remove javadocs from releases (except for publishing)
> -----------------------------------------------------
>
> Key: LUCENE-6257
> URL: https://issues.apache.org/jira/browse/LUCENE-6257
> Project: Lucene - Core
> Issue Type: Improvement
> Reporter: Ryan Ernst
> Priority: Major
> Attachments: screenshot-1.png, screenshot-2.png
>
>
> In LUCENE-6247, one idea discussed to decrease the size of release artifacts was to remove javadocs from the binary release. Anyone needing javadocs offline can download the source distribution and generate the javadocs.
> I also think we should investigate removing javadocs jars from maven. I did a quick test, and getting the source in intellij seemed sufficient to show javadocs. However, this test was far from scientific, so if someone knows for sure whether a separate javadocs jar is truly necessary, please say so.
> Regardless of the outcome of the two ideas above, we would continue building, validating and making the javadocs available online.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org