You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Hoss Man (JIRA)" <ji...@apache.org> on 2018/04/04 19:00:00 UTC
[jira] [Commented] (SOLR-10616) use more ant variables in ref guide
pages: particular for javadoc & third-party lib versions
[ https://issues.apache.org/jira/browse/SOLR-10616?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16426015#comment-16426015 ]
Hoss Man commented on SOLR-10616:
---------------------------------
I've worked up a patch that:
* adds a new {{java-javadocs}} variable for use in our {{*.adoc}} files
* replaces existing hardcoded {{docs.oracle.com/...}} javadoc urls with this variable
* removes a lot of unneccessarily specific mentions of "java 8" and just refers to "java" ...
The more I looked into references to "java 8" or "java 1.8" the less convinced i was that a variable would be useful here. In every case i found, i felt like either the docs were improved by being less specific, *OR* using a variable could easily lead to confusion/mistakes if/when we change our minimum version to java 9 ... in the latter cases, i made a note to revisit those specific sections in LUCENE-8154.
> use more ant variables in ref guide pages: particular for javadoc & third-party lib versions
> --------------------------------------------------------------------------------------------
>
> Key: SOLR-10616
> URL: https://issues.apache.org/jira/browse/SOLR-10616
> Project: Solr
> Issue Type: Sub-task
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation
> Reporter: Hoss Man
> Priority: Major
> Attachments: SOLR-10616.patch
>
>
> we already use ant variables for the lucene/solr version when building lucene/solr javadoc links, but it would be nice if we could slurp in the JDK javadoc URLs for the current java version & the versions.properties values for all third-party deps as well, so that links to things like the zookeeper guide, or the tika guide, or the javadocs for DateInstance would always be "current"
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org