[jira] [Commented] (CAMEL-13091) Ensure that all spring boot starters have all their options documented
[ https://issues.apache.org/jira/browse/CAMEL-13091?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16920146#comment-16920146 ] Przemyslaw Swiderski commented on CAMEL-13091: -- Done [https://github.com/apache/camel/pull/3132] > Ensure that all spring boot starters have all their options documented > -- > > Key: CAMEL-13091 > URL: https://issues.apache.org/jira/browse/CAMEL-13091 > Project: Camel > Issue Type: Task > Components: camel-spring-boot-starters >Reporter: Claus Ibsen >Priority: Major > Fix For: 3.x > > Time Spent: 10m > Remaining Estimate: 0h > > Some of the camel components do not have component level docs for all their > options, which are generated into the spring boot metadata. > You can see this with the build WARNs when building all the starter JARs. -- This message was sent by Atlassian Jira (v8.3.2#803003)
[jira] [Commented] (CAMEL-13091) Ensure that all spring boot starters have all their options documented
[
https://issues.apache.org/jira/browse/CAMEL-13091?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16915351#comment-16915351
]
Przemyslaw Swiderski commented on CAMEL-13091:
--
I filled the missing
{code:java}
// spring-boot-auto-configure options
{code}
tags in the following modules docs where the warning occurred:
* camel-bean-starter
* camel-hl7-starter
* camel-mock-starter
* camel-xpath
Spring Boot options sections were successfully generated.
I found that there are properties descriptions missing for:
* camel-corda-starter
* camel-google-bigquery-starter
* camel-google-pubsub-starter
* camel-jooq-starter
* camel-zookeeper-starter
Where can I find those descriptions?
> Ensure that all spring boot starters have all their options documented
> --
>
> Key: CAMEL-13091
> URL: https://issues.apache.org/jira/browse/CAMEL-13091
> Project: Camel
> Issue Type: Task
> Components: camel-spring-boot-starters
>Reporter: Claus Ibsen
>Priority: Major
> Fix For: 3.x
>
>
> Some of the camel components do not have component level docs for all their
> options, which are generated into the spring boot metadata.
> You can see this with the build WARNs when building all the starter JARs.
--
This message was sent by Atlassian Jira
(v8.3.2#803003)
[jira] [Commented] (CAMEL-13091) Ensure that all spring boot starters have all their options documented
[
https://issues.apache.org/jira/browse/CAMEL-13091?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16912087#comment-16912087
]
Przemyslaw Swiderski commented on CAMEL-13091:
--
Ok, but what should be done in case of warnings such as:
{code:java}
[WARNING] Cannot find markers in file
/home/jenkins/jenkins-slave/workspace/Camel_master-CIGY56HHEDNGVJBWJRRHBZ64GKNJTCSYDKOPJS46W5IZTMAS3I2Q/platforms/spring-boot/components-starter/camel-hl7-starter/../../../../components/camel-hl7/src/main/docs/hl7terser-language.adoc
[WARNING] Add the following markers
[WARNING] // spring-boot-auto-configure options: START
[WARNING] // spring-boot-auto-configure options: END
{code}
> Ensure that all spring boot starters have all their options documented
> --
>
> Key: CAMEL-13091
> URL: https://issues.apache.org/jira/browse/CAMEL-13091
> Project: Camel
> Issue Type: Task
> Components: camel-spring-boot-starters
>Reporter: Claus Ibsen
>Priority: Major
> Fix For: 3.x
>
>
> Some of the camel components do not have component level docs for all their
> options, which are generated into the spring boot metadata.
> You can see this with the build WARNs when building all the starter JARs.
--
This message was sent by Atlassian Jira
(v8.3.2#803003)
[jira] [Commented] (CAMEL-13091) Ensure that all spring boot starters have all their options documented
[ https://issues.apache.org/jira/browse/CAMEL-13091?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16911706#comment-16911706 ] Przemyslaw Swiderski commented on CAMEL-13091: -- Hi, is there any tool to generate adoc tables based on spring-configuration-metadata.json files? It would mke this task even easier. > Ensure that all spring boot starters have all their options documented > -- > > Key: CAMEL-13091 > URL: https://issues.apache.org/jira/browse/CAMEL-13091 > Project: Camel > Issue Type: Task > Components: camel-spring-boot-starters >Reporter: Claus Ibsen >Priority: Major > Fix For: 3.x > > > Some of the camel components do not have component level docs for all their > options, which are generated into the spring boot metadata. > You can see this with the build WARNs when building all the starter JARs. -- This message was sent by Atlassian Jira (v8.3.2#803003)
[jira] [Commented] (CAMEL-13871) documentation - Remove all the see also sections
[ https://issues.apache.org/jira/browse/CAMEL-13871?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16908403#comment-16908403 ] Przemyslaw Swiderski commented on CAMEL-13871: -- Hi, i would like to contribute to apache camel. I would like to take care of this issue. > documentation - Remove all the see also sections > > > Key: CAMEL-13871 > URL: https://issues.apache.org/jira/browse/CAMEL-13871 > Project: Camel > Issue Type: Task > Components: documentation >Reporter: Claus Ibsen >Priority: Major > Fix For: 3.0.0 > > Attachments: Screenshot 2019-08-15 at 19.49.42.png > > > We should remove all those see also sections for all the components and other > places as they dont bring much value. There is already a TOC for the user > guide that offers navigation to different topics. -- This message was sent by Atlassian JIRA (v7.6.14#76016)
