lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Uwe Schindler (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (SOLR-3733) better organization of javadocs in release
Date Sat, 15 Sep 2012 23:31:07 GMT

     [ https://issues.apache.org/jira/browse/SOLR-3733?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Uwe Schindler updated SOLR-3733:
--------------------------------

    Attachment: SOLR-3733.patch

Häckidy-Hick-Hack-Pätch:
- linter of course does not pass
- links between contribs/core/... not working/enabled
- the documentation directory is structured like in Lucene, all javadocs go to top-level build/docs
folder
- index.html is created there automatically by xsl including links to tutorial (more will
come later)
- tutorial.html moved from doc-file up into site/html folder (as it does not relate to javadocs
at all, it's just a plain old HTML page
- There are still some doc-files folders in core which are completely misplaced (and dont
work). Seem to be dead docs.
- Javadocs-all nuked

I will need Robert's help to get inter-module links working.
                
> 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
>         Attachments: SOLR-3733.patch
>
>
> 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
For more information on JIRA, see: http://www.atlassian.com/software/jira

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message