[ 
https://issues.apache.org/jira/browse/SOLR-3733?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13435618#comment-13435618
 ] 

Hoss Man commented on SOLR-3733:
--------------------------------

I agree that a cleanup is in order, but i'm torn on whether it makes sense for 
Solr to get rid of the "all javadocs" directory like we did for lucene-core.

The key issue in my mind is that most Solr users aren't java devs/users, but 
the majority of documentation about what "plugins" are available in solr OOTB 
comes from the javadoc "known subclasses" information.  So while individual 
javadoc dirs for solr-core/solrj/contribs/test-framework are nice because they 
make it really clear what features available in each individual jar, having hte 
"all javadocs" directory gives us URLs for each type of "plugin" that we can 
point people to that not only give a basic summary of what that plugin type is 
used for, but also get a simple list of the implementations available in the 
entire solr distribution, regardless of what contrib it's in...

* 
http://lucene.apache.org/solr/api-4_0_0-BETA/org/apache/solr/update/processor/UpdateRequestProcessorFactory.html
* 
http://lucene.apache.org/solr/api-4_0_0-BETA/org/apache/solr/handler/component/SearchComponent.html
* 
http://lucene.apache.org/solr/api-4_0_0-BETA/org/apache/solr/response/QueryResponseWriter.html
* 
http://lucene.apache.org/solr/api-4_0_0-BETA/org/apache/solr/schema/FieldType.html
* etc...

In any case ... i just wanted to bring it up for consideration.  Not sure if 
anyone else has an opinion.
                
> better organization of javadocs in release
> ------------------------------------------
>
>                 Key: SOLR-3733
>                 URL: https://issues.apache.org/jira/browse/SOLR-3733
>             Project: Solr
>          Issue Type: Task
>          Components: Build
>            Reporter: Robert Muir
>
> Just an issue to try to improve the stuff mentioned in SOLR-3690.
> Currently there is one directory api/ which is 'all javadocs'
> then solrj javadocs are duplicated again under api/solrj
> now also test-framework is underneath.
> But this isnt very navigable, and these additional folders
> (duplicate or not) are hidden behind the index.html on the website.
> we can improve this and probably generate a landing page from
> the build.xml descriptions etc like Lucene. 

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: 
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to