[jira] [Commented] (CAMEL-13902) Publish links to JavaDoc on the website
[ https://issues.apache.org/jira/browse/CAMEL-13902?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17054957#comment-17054957 ] Aashna Jena commented on CAMEL-13902: - [~zregvart] Sounds great! For now, I'll add an "API documentation" under the "Documentation" menu and point it to [[https://www.javadoc.io/doc/org.apache.camel/camel-api/latest/index.html |http://example.com]|https://www.javadoc.io/doc/org.apache.camel/camel-api/latest/index.html] After that I'll start working on issue-14581 and propose some ideas for reorganisation. Is that okay? > Publish links to JavaDoc on the website > --- > > Key: CAMEL-13902 > URL: https://issues.apache.org/jira/browse/CAMEL-13902 > Project: Camel > Issue Type: Task > Components: website >Reporter: Zoran Regvart >Priority: Major > Labels: help-wanted > > We can utilize javadoc.io to publish the JavaDoc for: > * camel-api > * camel-support > * camel-util -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (CAMEL-13902) Publish links to JavaDoc on the website
[
https://issues.apache.org/jira/browse/CAMEL-13902?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17054910#comment-17054910
]
Zoran Regvart commented on CAMEL-13902:
---
[~aashnajena] I think we should point to
https://www.javadoc.io/doc/org.apache.camel/camel-api/latest/index.html this
constitutes the public API of Camel. The usability issues of the documentation
menu are discussed in CAMEL-14581. The static content in {{content/docs}} is
built by Hugo and published as HTML.
> Publish links to JavaDoc on the website
> ---
>
> Key: CAMEL-13902
> URL: https://issues.apache.org/jira/browse/CAMEL-13902
> Project: Camel
> Issue Type: Task
> Components: website
>Reporter: Zoran Regvart
>Priority: Major
> Labels: help-wanted
>
> We can utilize javadoc.io to publish the JavaDoc for:
> * camel-api
> * camel-support
> * camel-util
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Commented] (CAMEL-13902) Publish links to JavaDoc on the website
[ https://issues.apache.org/jira/browse/CAMEL-13902?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17053643#comment-17053643 ] Aashna Jena commented on CAMEL-13902: - Hi Zoran, I have added a block similar to [https://github.com/apache/camel-website/blob/22bb87f8127ae3a95c1b581433aded691d34333d/config.toml#L59-L64|http://example.com] I am able to display the option "API Documentation" in the menu now (see image). Can you which webpage this link should navigate to? And what should be the content of that webpage? Your comment above says that this menu option should point to api.md file. Should this menu option direct to the GitHub page with the api.md file? Or should it direct to a webpage like /manual/latest/getting-started.html etc? Also, please tell me what should be the content of api.md !camel_website.png! . Where s > Publish links to JavaDoc on the website > --- > > Key: CAMEL-13902 > URL: https://issues.apache.org/jira/browse/CAMEL-13902 > Project: Camel > Issue Type: Task > Components: website >Reporter: Zoran Regvart >Priority: Major > Labels: help-wanted > > We can utilize javadoc.io to publish the JavaDoc for: > * camel-api > * camel-support > * camel-util -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (CAMEL-13902) Publish links to JavaDoc on the website
[ https://issues.apache.org/jira/browse/CAMEL-13902?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17053493#comment-17053493 ] Zoran Regvart commented on CAMEL-13902: --- Hi [~aashnajena] of course, feel free to familiarize yourself with the website from the [README|https://github.com/apache/camel-website/blob/master/README.md] we have and how to get started in contributing from our [contribution guide|https://camel.apache.org/manual/latest/contributing.html]. I think we can start by publishing the documentation for the camel-spi. I am a bit worried that the big menus we currently have reflect poorly on the usability of the site. I think we could use also some ideas in this area on how to best organize and present all the documentation we have. > Publish links to JavaDoc on the website > --- > > Key: CAMEL-13902 > URL: https://issues.apache.org/jira/browse/CAMEL-13902 > Project: Camel > Issue Type: Task > Components: website >Reporter: Zoran Regvart >Priority: Major > Labels: help-wanted > > We can utilize javadoc.io to publish the JavaDoc for: > * camel-api > * camel-support > * camel-util -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (CAMEL-13902) Publish links to JavaDoc on the website
[ https://issues.apache.org/jira/browse/CAMEL-13902?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17053461#comment-17053461 ] Aashna Jena commented on CAMEL-13902: - Hi! Can I take up this issue? I'm looking at all the links given the comments above and I'd love to make my first contribution to the Camel website > Publish links to JavaDoc on the website > --- > > Key: CAMEL-13902 > URL: https://issues.apache.org/jira/browse/CAMEL-13902 > Project: Camel > Issue Type: Task > Components: website >Reporter: Zoran Regvart >Priority: Major > Labels: help-wanted > > We can utilize javadoc.io to publish the JavaDoc for: > * camel-api > * camel-support > * camel-util -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (CAMEL-13902) Publish links to JavaDoc on the website
[ https://issues.apache.org/jira/browse/CAMEL-13902?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16916145#comment-16916145 ] Zoran Regvart commented on CAMEL-13902: --- We could add the "API documentation" link in the Hugo configuration (also manages the Antora menus) by creating another block similar to this one: [https://github.com/apache/camel-website/blob/22bb87f8127ae3a95c1b581433aded691d34333d/config.toml#L59-L64] And then increasing all the weights by one after it, so we get Getting started, User manual, Component reference, API documentation, Camel K... on the Documentation menu. This menu item can point to a api.md that we can put here: [https://github.com/apache/camel-website/tree/master/content/docs] which in turn can have the links to javadoc.io for the 3.0 of the above mentioned artifacts and the 2.24 for camel-core. > Publish links to JavaDoc on the website > --- > > Key: CAMEL-13902 > URL: https://issues.apache.org/jira/browse/CAMEL-13902 > Project: Camel > Issue Type: Task > Components: website >Reporter: Zoran Regvart >Priority: Major > > We can utilize javadoc.io to publish the JavaDoc for: > * camel-api > * camel-support > * camel-util -- This message was sent by Atlassian Jira (v8.3.2#803003)
[jira] [Commented] (CAMEL-13902) Publish links to JavaDoc on the website
[ https://issues.apache.org/jira/browse/CAMEL-13902?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16915544#comment-16915544 ] Michele Mauro commented on CAMEL-13902: --- Right now, the JavaDocs can be found at: https://www.javadoc.io/doc/org.apache.camel// I.e.: core components, current 2.x: [https://www.javadoc.io/doc/org.apache.camel/camel-core/2.24.1] > Publish links to JavaDoc on the website > --- > > Key: CAMEL-13902 > URL: https://issues.apache.org/jira/browse/CAMEL-13902 > Project: Camel > Issue Type: Task > Components: website >Reporter: Zoran Regvart >Priority: Major > > We can utilize javadoc.io to publish the JavaDoc for: > * camel-api > * camel-support > * camel-util -- This message was sent by Atlassian Jira (v8.3.2#803003)
