Re: gitbook based doc generation

2016-07-03 Thread Andrea Cosentino
ndrea Cosentino Sent: Thursday, June 30, 2016 3:39 PM Subject: Re: gitbook based doc generation Great work so far. We also need to auto generate the EIP options. And the same for data formats. And maybe also languages, though most of them don't have options, but there a few that have some special op

Re: gitbook based doc generation

2016-06-30 Thread Andrea Cosentino
ne 30, 2016 3:39 PM Subject: Re: gitbook based doc generation Great work so far. We also need to auto generate the EIP options. And the same for data formats. And maybe also languages, though most of them don't have options, but there a few that have some special options like jsonpath for

Re: gitbook based doc generation

2016-06-30 Thread Claus Ibsen
on the way we should implement this. > > If this is the way forward we must also find a solution for the > endpoint-configuration containing the groups. > I think we should present the configurations grouped by "group". > Does anybody know how this is done in mvel? >

Re: gitbook based doc generation

2016-06-30 Thread Andrea Cosentino
ration containing the groups. I think we should present the configurations grouped by "group". Does anybody know how this is done in mvel? -- View this message in context: http://camel.465427.n5.nabble.com/gitbook-based-doc-generation-tp5776497p5784543.html Sent from the Camel Development mailing list archive at Nabble.com.

Re: gitbook based doc generation

2016-06-30 Thread Andrea Cosentino
://camel.465427.n5.nabble.com/gitbook-based-doc-generation-tp5776497p5784543.html Sent from the Camel Development mailing list archive at Nabble.com.

Re: gitbook based doc generation

2016-06-29 Thread Andrea Cosentino
t: http://camel.465427.n5.nabble.com/gitbook-based-doc-generation-tp5776497p5784543.html Sent from the Camel Development mailing list archive at Nabble.com.

Re: gitbook based doc generation

2016-06-29 Thread arno noordover
;group". Does anybody know how this is done in mvel? -- View this message in context: http://camel.465427.n5.nabble.com/gitbook-based-doc-generation-tp5776497p5784543.html Sent from the Camel Development mailing list archive at Nabble.com.

Re: gitbook based doc generation

2016-06-09 Thread Andrea Cosentino
Yeah! Thanks! -- Andrea Cosentino -- Apache Camel PMC Member Apache Karaf Committer Apache Servicemix Committer Email: ancosen1...@yahoo.com Twitter: @oscerd2 Github: oscerd On Thursday, June 9, 2016 3:43 PM, Claus Ibsen wrote: Hi I added so the tool will skip

Re: gitbook based doc generation

2016-06-09 Thread Claus Ibsen
Hi I added so the tool will skip some modules in that check https://github.com/apache/camel/commit/9491da8f393fa95fb33cf3afcb65dab88be63f86 We can add to that list later if we find out some more do not need adoc files. On Thu, Jun 9, 2016 at 3:25 PM, Andrea Cosentino wrote: > Yeah, sorry my m

Re: gitbook based doc generation

2016-06-09 Thread Andrea Cosentino
Yeah, sorry my mistake. I always forge to clean up :-) New list [WARNING] Missing document detected: 28 [WARNING] camel-atmos [WARNING] camel-cm-sms [WARNING] camel-coap [WARNING] camel-context [WARNING] camel-core-osgi [

Re: gitbook based doc generation

2016-06-09 Thread Claus Ibsen
Hi Great to hear we are so far away already. For that list there is some false alarms we can turn off, such as some of those test modules etc. Also the list seems to look in dirs that has been removed. You can try run git clean -d -f On Thu, Jun 9, 2016 at 2:33 PM, Andrea Cosentino wrote:

Re: gitbook based doc generation

2016-06-09 Thread Andrea Cosentino
Currently I've migrated the biggest part of components from confluence to Asciidoc. Maybe there are still asciidoc file that don't have the placeholder for automatic generation of docs. If you find them, please commit the change and re-generate documentation. Using the catalog maven plugin I h

Re: gitbook based doc generation

2016-01-27 Thread Claus Ibsen
On Wed, Jan 27, 2016 at 4:10 PM, Antonin Stefanutti wrote: > I’ve just tried it successfully for the Twitter component (both component and > endpoint options). > > That’d be nice to have the ability to style the description. For example > {@code TwitterComponent} from the Javadoc would render as

Re: gitbook based doc generation

2016-01-27 Thread Antonin Stefanutti
I’ve just tried it successfully for the Twitter component (both component and endpoint options). That’d be nice to have the ability to style the description. For example {@code TwitterComponent} from the Javadoc would render as an inline code block in the description column. Antonin > On 27

Re: gitbook based doc generation

2016-01-27 Thread Claus Ibsen
Hi I just added support for component option as well, so its similar style. Add comments but use component instead of endpoint. And I enabled the goal to run on components/pom.xml so it runs by default now. So you should be able to try this on all the existing .adoc files. On Wed, Jan 27, 201

Re: gitbook based doc generation

2016-01-27 Thread Andrea Cosentino
Ok, then we'll continue to import docs and when we have enough material we can add comments everywhere :-) -- Andrea Cosentino -- Apache Camel PMC Member Apache Karaf Committer Email: ancosen1...@yahoo.com Twitter: @oscerd2 Github: oscerd On Wednesday, January

Re: gitbook based doc generation

2016-01-27 Thread Antonin Stefanutti
> On 27 Jan 2016, at 13:51, Claus Ibsen wrote: > > On Wed, Jan 27, 2016 at 1:07 PM, Antonin Stefanutti > wrote: >> Yes I think we should add the comments. >> >> For the SJMS and Metrics components, it shows the need to be able to >> categorise the options. Obvious categories would be 'consume

Re: gitbook based doc generation

2016-01-27 Thread Claus Ibsen
On Wed, Jan 27, 2016 at 1:07 PM, Antonin Stefanutti wrote: > Yes I think we should add the comments. > > For the SJMS and Metrics components, it shows the need to be able to > categorise the options. Obvious categories would be 'consumer' and 'producer' > though for components like Metrics, some

Re: gitbook based doc generation

2016-01-27 Thread Claus Ibsen
On Wed, Jan 27, 2016 at 12:42 PM, Andrea Cosentino wrote: > Maybe we can start adding the comments > Yeah we could try that, basically move the plugin from camel-ahc to the components/pom.xml so it runs for all those components. It only do changes if there is an .adoc file and that it has those

Re: gitbook based doc generation

2016-01-27 Thread Antonin Stefanutti
Yes I think we should add the comments. For the SJMS and Metrics components, it shows the need to be able to categorise the options. Obvious categories would be 'consumer' and 'producer' though for components like Metrics, some options are only applicable to a certain URI remaining that are com

Re: gitbook based doc generation

2016-01-27 Thread Andrea Cosentino
Maybe we can start adding the comments -- Andrea Cosentino -- Apache Camel PMC Member Apache Karaf Committer Email: ancosen1...@yahoo.com Twitter: @oscerd2 Github: oscerd On Wednesday, January 27, 2016 11:25 AM, Claus Ibsen wrote: Hi I worked a bit more on

Re: gitbook based doc generation

2016-01-27 Thread Andrea Cosentino
Maybe we can start adding the comments // endpoint options: START // endpoint options: END on the asciidoc we've already committed. WDYT? -- Andrea Cosentino -- Apache Camel PMC Member Apache Karaf Committer Email: ancosen1...@yahoo.com Twitter: @oscerd2 Github:

Re: gitbook based doc generation

2016-01-27 Thread Claus Ibsen
Hi I worked a bit more on this and have made the plugin update the existing adoc file (if present). And I have used the camel-ahc as experiment. The online page at https://github.com/apache/camel/blob/master/components/camel-ahc/src/main/docs/ahc.adoc Has all those endpoint options generated fro

Re: gitbook based doc generation

2016-01-26 Thread Andrea Cosentino
Great stuff, Looking forward for the end of the docs migration to Asciidoc and the integration of this in the full build process! :-) Andrea -- Andrea Cosentino -- Apache Camel PMC Member Apache Karaf Committer Email: ancosen1...@yahoo.com Twitter: @oscerd2 Gi

Re: gitbook based doc generation

2016-01-26 Thread Claus Ibsen
Hi I just pushed some code I started end of last year on a train ride back when returning from x-mas holiday. The code is in tooling/maven/camel-package-maven-plugin where there is a new maven goal called update-readme. https://github.com/apache/camel/blob/master/tooling/maven/camel-package-maven

Re: gitbook based doc generation

2016-01-24 Thread Carl Nygard
For what it's worth, I've integrated gitbook into my maven build with the help of a docker container: maven-antrun-plugin ${maven-antrun-plugin.version} gitbook-pdf prepare-package

Re: gitbook based doc generation

2016-01-22 Thread Claus Ibsen
Hi Hiram Thanks for experimenting with this. Better documentation and ... website is something I would love to see happen. All the hard work we have done with making Camel components "self documenting" plays a part here, as we should be able to auto generate part of the documentation, such as al

Re: gitbook based doc generation

2016-01-21 Thread Hiram Chirino
I took a crack at converting one of the wiki pages, the JMS component reference. Seems like we can automate most of the work of exporting to asciidoc format. I used the cxf-web tool [1] to export all the pages with a template which only includes the body content. Then ran `pandoc --from html --to

Re: gitbook based doc generation

2016-01-21 Thread Andrea Cosentino
Hi Hiram, Great! Thanks! -- Andrea Cosentino -- Apache Camel PMC Member Apache Karaf Committer Email: ancosen1...@yahoo.com Twitter: @oscerd2 Github: oscerd On Thursday, January 21, 2016 4:29 PM, Hiram Chirino wrote: Hi folks, The artemis project has been u

gitbook based doc generation

2016-01-21 Thread Hiram Chirino
Hi folks, The artemis project has been using a gitbook based tool chain to generate their docs from project source that seems kinda cool. I know a while back we discussed moving more of our docs out of confluence and have it versioned with the project source code. So a first step toward that goa