[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=17149667#comment-17149667 ] Claus Ibsen commented on CAMEL-13091: - There is another up to date JIRA about this, so we can find that ticket and close this as a duplicate > 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 > Labels: help-wanted > Fix For: 3.x > > Time Spent: 20m > 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.4#803005)
[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=17149665#comment-17149665 ] Claus Ibsen commented on CAMEL-13091: - Its in the source code typically in the javadocs in the camel components that the starters use to generate its documentation from. > 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 > Labels: help-wanted > Fix For: 3.x > > Time Spent: 20m > 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.4#803005)
[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=17149572#comment-17149572 ] rodrigo coelho commented on CAMEL-13091: Hello, Where can we find the descriptions for the camel-zookeeper? > 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 > Labels: help-wanted > Fix For: 3.x > > Time Spent: 20m > 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.4#803005)
[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=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=16920051#comment-16920051 ] Claus Ibsen commented on CAMEL-13091: - Can you create a PR for the ones you have fixed so far. Then we can take a look at the remainder afterwards > 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=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=16912652#comment-16912652 ] Claus Ibsen commented on CAMEL-13091: - In the file hl7terser-language.adoc you add those 2 commented lines, and then regen the build, and it will include the spring boot docs in between those 2 lines. Take a look at one of the other adoc files to see how a working file looks like > 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=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=16911745#comment-16911745
]
Jan Bednar commented on CAMEL-13091:
[~swidersk7] What tool do you mean? The adoc files are already generated and
there is no need to update them manually.
*This task is about:*
# Find all component docs warning `
{{[WARNING] Option aaa.bbb.ccc.d has no description}}
during build - eg here:
[https://builds.apache.org/job/Camel/job/master/1483/consoleFull]
# For every warning find relevant code with {{Metadata}} annotation and add
{{description}} attribute into this annotation.
# Do full build - documentation will be updated automatically
> 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=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)
