[jira] [Commented] (CALCITE-1160) Avatica javadoc

["Kevin Risden (JIRA)" <ji...@apache.org>]

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

Kevin Risden commented on CALCITE-1160:
---------------------------------------

Reviewing the current state of the Avatica site:
 * javadocs look to be published separately from Calcite and calcite-avatica/site/README.md has steps to publish javadoc
 * No linking between calcite javadoc and avatica javadoc
 * Avatica home page has a link to Calcite
 * Still missing a favicon for /avatica/
 * Community page is still a mess - would be good to link to Calcite (could do with a redirect)
 * The Avatica menu has redirects as fixed in CALCITE-1677

> Avatica javadoc
> ---------------
>
>                 Key: CALCITE-1160
>                 URL: https://issues.apache.org/jira/browse/CALCITE-1160
>             Project: Calcite
>          Issue Type: Bug
>          Components: avatica, site
>            Reporter: Julian Hyde
>            Assignee: Julian Hyde
>            Priority: Major
>
> Figure out how we want to publish Avatica javadoc.
> Right now the javadoc points to the javadoc that was generated in the previous calcite release. When I generate javadoc for calcite 1.7 the contents will no longer include avatica packages. The javadoc for each package will still be there in the web site until I explicitly delete it.
> * Should http://calcite.apache.org/avatica/docs/ have "api" and "test api" links?
> * Should avatica javadoc be separate from calcite javadoc?
> * Make calcite javadoc reference avatica javadoc (i.e. uses of avatica classes should be hyperlinks)
> * Document a process to re-generate avatica javadoc as part of an avatica release



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)