[jira] [Commented] (QUARKS-48) Generate JavaDoc for website

["Dale LaBossiere (JIRA)" <ji...@apache.org>]

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

Dale LaBossiere commented on QUARKS-48:
---------------------------------------

Not sure if this is the right jira for this...

I recently copied an existing pattern for referencing javadoc from a recipe (recipe_value_out_of_range.md) and my link is broken.
That pattern is using quarks-edge.github.io - e.g., http://quarks-edge.github.io/quarks/docs/javadoc/quarks/topology/TStream.html

The link that I specified is for a relatively new class (quarks.analytics.sensors.Range) and isn't present in the javadoc exposed by quarks-edge.github.io.  I guess makes a some sense because I assume it's the javadoc for the current state of the (~abandoned) quarks-edge site.

I get the feeling that I should just leave my broken link as is for now?

Will this Jira will include going through the incubator-quarks-website content and cleaning up all of the quarks-edge urls floating around?

Can/should anything be done in the meantime so the recipes' javadoc links are accurate - e.g., (cough) putting the current quarks javadoc on quarks-edge.github.io?  :-)

> Generate JavaDoc for website
> ----------------------------
>
>                 Key: QUARKS-48
>                 URL: https://issues.apache.org/jira/browse/QUARKS-48
>             Project: Quarks
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Cazen Lee
>
> I'm not sure but it seems that Javadoc branch does not exist.
> I think we can make JavaDoc branch like below:
> https://github.com/quarks-edge/quarks/tree/gh-pages



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)