You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@camel.apache.org by Claus Ibsen <cl...@gmail.com> on 2016/04/06 09:33:05 UTC

Camel component docs - What is missing

Hi

I added a report output when building camel-catalog, that prints which
camel component modules that do not have any src/main/docs files.

This can help us keep an eye on how many we have yet to do.

Mind it only reports on directory level. So if a module has such as 3
components then it will report it as not missing if there is 1 adoc
file. But when you build the said module then it logs a WARN if any
Camel component do not have any adoc file.

Here is just a snippet

[WARNING] Missing document detected: 78
[WARNING] camel-ahc
[WARNING] camel-ahc-ws
[WARNING] camel-amqp
[WARNING] camel-apns
[WARNING] camel-atmosphere-websocket
[WARNING] camel-atom
[WARNING] camel-avro
[WARNING] camel-aws
[WARNING] camel-bam

You can try with

mvn clean install

in the platforms/catalog directory.




-- 
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2

Re: Camel component docs - What is missing

Posted by Andrea Cosentino <an...@yahoo.com.INVALID>.
I will take care of this.

I think this feature is very important :-)

Thank you for your time! :-)
 --
Andrea Cosentino 
----------------------------------
Apache Camel PMC Member
Apache Karaf Committer
Apache Servicemix Committer
Email: ancosen1985@yahoo.com
Twitter: @oscerd2
Github: oscerd



On Wednesday, April 6, 2016 10:15 AM, Claus Ibsen <cl...@gmail.com> wrote:
Ah sorry there was a bug in the maven tooling.

It should use == and not != in a check

I will fix it later as I am in the middle of something. You can also
fix it if you got the time

It should be

if (before == after) {
    missingAdocFiles.add(dir);
}

Instead of

if (before != after) {
    missingAdocFiles.add(dir);
}

On Wed, Apr 6, 2016 at 10:08 AM, Andrea Cosentino
<an...@yahoo.com.invalid> wrote:
> I've executed an mvn clean install of all Camel and then run mvn clean install on catalog.
>  --
> Andrea Cosentino
> ----------------------------------
> Apache Camel PMC Member
> Apache Karaf Committer
> Apache Servicemix Committer
> Email: ancosen1985@yahoo.com
> Twitter: @oscerd2
> Github: oscerd
>
>
>
> On Wednesday, April 6, 2016 10:04 AM, Claus Ibsen <cl...@gmail.com> wrote:
> On Wed, Apr 6, 2016 at 10:01 AM, Andrea Cosentino
> <an...@yahoo.com.invalid> wrote:
>> Hi Claus,
>>
>> It's a bit weird.
>>
>> I run mvn clean install and from the list it seems we don't have docs, but for example on
>>
>> https://github.com/apache/camel/tree/master/components/camel-ahc/src/main/docs
>>
>> We have already an .adoc file.
>>
>
> Ah you need to build the maven tooling first,
>
> cd tooling/maven
> mvn clean install
>
>
>> Actually I've arrived at camel-hdfs.
>>  --
>> Andrea Cosentino
>> ----------------------------------
>> Apache Camel PMC Member
>> Apache Karaf Committer
>> Apache Servicemix Committer
>> Email: ancosen1985@yahoo.com
>> Twitter: @oscerd2
>> Github: oscerd
>>
>>
>>
>> On Wednesday, April 6, 2016 9:33 AM, Claus Ibsen <cl...@gmail.com> wrote:
>> Hi
>>
>> I added a report output when building camel-catalog, that prints which
>> camel component modules that do not have any src/main/docs files.
>>
>> This can help us keep an eye on how many we have yet to do.
>>
>> Mind it only reports on directory level. So if a module has such as 3
>> components then it will report it as not missing if there is 1 adoc
>> file. But when you build the said module then it logs a WARN if any
>> Camel component do not have any adoc file.
>>
>> Here is just a snippet
>>
>> [WARNING] Missing document detected: 78
>> [WARNING] camel-ahc
>> [WARNING] camel-ahc-ws
>> [WARNING] camel-amqp
>> [WARNING] camel-apns
>> [WARNING] camel-atmosphere-websocket
>> [WARNING] camel-atom
>> [WARNING] camel-avro
>> [WARNING] camel-aws
>> [WARNING] camel-bam
>>
>> You can try with
>>
>> mvn clean install
>>
>> in the platforms/catalog directory.
>>
>>
>>
>>
>> --
>> Claus Ibsen
>> -----------------
>> http://davsclaus.com @davsclaus
>> Camel in Action 2: https://www.manning.com/ibsen2

>
>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2



-- 
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2

Re: Camel component docs - What is missing

Posted by Claus Ibsen <cl...@gmail.com>.
Ah sorry there was a bug in the maven tooling.

It should use == and not != in a check

I will fix it later as I am in the middle of something. You can also
fix it if you got the time

It should be

if (before == after) {
    missingAdocFiles.add(dir);
}

Instead of

if (before != after) {
    missingAdocFiles.add(dir);
}

On Wed, Apr 6, 2016 at 10:08 AM, Andrea Cosentino
<an...@yahoo.com.invalid> wrote:
> I've executed an mvn clean install of all Camel and then run mvn clean install on catalog.
>  --
> Andrea Cosentino
> ----------------------------------
> Apache Camel PMC Member
> Apache Karaf Committer
> Apache Servicemix Committer
> Email: ancosen1985@yahoo.com
> Twitter: @oscerd2
> Github: oscerd
>
>
>
> On Wednesday, April 6, 2016 10:04 AM, Claus Ibsen <cl...@gmail.com> wrote:
> On Wed, Apr 6, 2016 at 10:01 AM, Andrea Cosentino
> <an...@yahoo.com.invalid> wrote:
>> Hi Claus,
>>
>> It's a bit weird.
>>
>> I run mvn clean install and from the list it seems we don't have docs, but for example on
>>
>> https://github.com/apache/camel/tree/master/components/camel-ahc/src/main/docs
>>
>> We have already an .adoc file.
>>
>
> Ah you need to build the maven tooling first,
>
> cd tooling/maven
> mvn clean install
>
>
>> Actually I've arrived at camel-hdfs.
>>  --
>> Andrea Cosentino
>> ----------------------------------
>> Apache Camel PMC Member
>> Apache Karaf Committer
>> Apache Servicemix Committer
>> Email: ancosen1985@yahoo.com
>> Twitter: @oscerd2
>> Github: oscerd
>>
>>
>>
>> On Wednesday, April 6, 2016 9:33 AM, Claus Ibsen <cl...@gmail.com> wrote:
>> Hi
>>
>> I added a report output when building camel-catalog, that prints which
>> camel component modules that do not have any src/main/docs files.
>>
>> This can help us keep an eye on how many we have yet to do.
>>
>> Mind it only reports on directory level. So if a module has such as 3
>> components then it will report it as not missing if there is 1 adoc
>> file. But when you build the said module then it logs a WARN if any
>> Camel component do not have any adoc file.
>>
>> Here is just a snippet
>>
>> [WARNING] Missing document detected: 78
>> [WARNING] camel-ahc
>> [WARNING] camel-ahc-ws
>> [WARNING] camel-amqp
>> [WARNING] camel-apns
>> [WARNING] camel-atmosphere-websocket
>> [WARNING] camel-atom
>> [WARNING] camel-avro
>> [WARNING] camel-aws
>> [WARNING] camel-bam
>>
>> You can try with
>>
>> mvn clean install
>>
>> in the platforms/catalog directory.
>>
>>
>>
>>
>> --
>> Claus Ibsen
>> -----------------
>> http://davsclaus.com @davsclaus
>> Camel in Action 2: https://www.manning.com/ibsen2
>
>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2



-- 
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2

Re: Camel component docs - What is missing

Posted by Andrea Cosentino <an...@yahoo.com.INVALID>.
I've executed an mvn clean install of all Camel and then run mvn clean install on catalog.
 --
Andrea Cosentino 
----------------------------------
Apache Camel PMC Member
Apache Karaf Committer
Apache Servicemix Committer
Email: ancosen1985@yahoo.com
Twitter: @oscerd2
Github: oscerd



On Wednesday, April 6, 2016 10:04 AM, Claus Ibsen <cl...@gmail.com> wrote:
On Wed, Apr 6, 2016 at 10:01 AM, Andrea Cosentino
<an...@yahoo.com.invalid> wrote:
> Hi Claus,
>
> It's a bit weird.
>
> I run mvn clean install and from the list it seems we don't have docs, but for example on
>
> https://github.com/apache/camel/tree/master/components/camel-ahc/src/main/docs
>
> We have already an .adoc file.
>

Ah you need to build the maven tooling first,

cd tooling/maven
mvn clean install


> Actually I've arrived at camel-hdfs.
>  --
> Andrea Cosentino
> ----------------------------------
> Apache Camel PMC Member
> Apache Karaf Committer
> Apache Servicemix Committer
> Email: ancosen1985@yahoo.com
> Twitter: @oscerd2
> Github: oscerd
>
>
>
> On Wednesday, April 6, 2016 9:33 AM, Claus Ibsen <cl...@gmail.com> wrote:
> Hi
>
> I added a report output when building camel-catalog, that prints which
> camel component modules that do not have any src/main/docs files.
>
> This can help us keep an eye on how many we have yet to do.
>
> Mind it only reports on directory level. So if a module has such as 3
> components then it will report it as not missing if there is 1 adoc
> file. But when you build the said module then it logs a WARN if any
> Camel component do not have any adoc file.
>
> Here is just a snippet
>
> [WARNING] Missing document detected: 78
> [WARNING] camel-ahc
> [WARNING] camel-ahc-ws
> [WARNING] camel-amqp
> [WARNING] camel-apns
> [WARNING] camel-atmosphere-websocket
> [WARNING] camel-atom
> [WARNING] camel-avro
> [WARNING] camel-aws
> [WARNING] camel-bam
>
> You can try with
>
> mvn clean install
>
> in the platforms/catalog directory.
>
>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2




-- 
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2

Re: Camel component docs - What is missing

Posted by Claus Ibsen <cl...@gmail.com>.
On Wed, Apr 6, 2016 at 10:01 AM, Andrea Cosentino
<an...@yahoo.com.invalid> wrote:
> Hi Claus,
>
> It's a bit weird.
>
> I run mvn clean install and from the list it seems we don't have docs, but for example on
>
> https://github.com/apache/camel/tree/master/components/camel-ahc/src/main/docs
>
> We have already an .adoc file.
>

Ah you need to build the maven tooling first,

cd tooling/maven
mvn clean install


> Actually I've arrived at camel-hdfs.
>  --
> Andrea Cosentino
> ----------------------------------
> Apache Camel PMC Member
> Apache Karaf Committer
> Apache Servicemix Committer
> Email: ancosen1985@yahoo.com
> Twitter: @oscerd2
> Github: oscerd
>
>
>
> On Wednesday, April 6, 2016 9:33 AM, Claus Ibsen <cl...@gmail.com> wrote:
> Hi
>
> I added a report output when building camel-catalog, that prints which
> camel component modules that do not have any src/main/docs files.
>
> This can help us keep an eye on how many we have yet to do.
>
> Mind it only reports on directory level. So if a module has such as 3
> components then it will report it as not missing if there is 1 adoc
> file. But when you build the said module then it logs a WARN if any
> Camel component do not have any adoc file.
>
> Here is just a snippet
>
> [WARNING] Missing document detected: 78
> [WARNING] camel-ahc
> [WARNING] camel-ahc-ws
> [WARNING] camel-amqp
> [WARNING] camel-apns
> [WARNING] camel-atmosphere-websocket
> [WARNING] camel-atom
> [WARNING] camel-avro
> [WARNING] camel-aws
> [WARNING] camel-bam
>
> You can try with
>
> mvn clean install
>
> in the platforms/catalog directory.
>
>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2



-- 
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2

Re: Camel component docs - What is missing

Posted by Andrea Cosentino <an...@yahoo.com.INVALID>.
Hi Claus,

It's a bit weird.

I run mvn clean install and from the list it seems we don't have docs, but for example on

https://github.com/apache/camel/tree/master/components/camel-ahc/src/main/docs

We have already an .adoc file.

Actually I've arrived at camel-hdfs.
 --
Andrea Cosentino 
----------------------------------
Apache Camel PMC Member
Apache Karaf Committer
Apache Servicemix Committer
Email: ancosen1985@yahoo.com
Twitter: @oscerd2
Github: oscerd



On Wednesday, April 6, 2016 9:33 AM, Claus Ibsen <cl...@gmail.com> wrote:
Hi

I added a report output when building camel-catalog, that prints which
camel component modules that do not have any src/main/docs files.

This can help us keep an eye on how many we have yet to do.

Mind it only reports on directory level. So if a module has such as 3
components then it will report it as not missing if there is 1 adoc
file. But when you build the said module then it logs a WARN if any
Camel component do not have any adoc file.

Here is just a snippet

[WARNING] Missing document detected: 78
[WARNING] camel-ahc
[WARNING] camel-ahc-ws
[WARNING] camel-amqp
[WARNING] camel-apns
[WARNING] camel-atmosphere-websocket
[WARNING] camel-atom
[WARNING] camel-avro
[WARNING] camel-aws
[WARNING] camel-bam

You can try with

mvn clean install

in the platforms/catalog directory.




-- 
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2

Re: Camel component docs - What is missing

Posted by Claus Ibsen <cl...@gmail.com>.
On Wed, Apr 6, 2016 at 9:38 AM, Claus Ibsen <cl...@gmail.com> wrote:
> And btw we should consider a structure naming for the src/main/docs
> folder so we can differentiate what the docs are for as a Maven module
> may include both components / data formats / languages etc.
>
> So I would consider doing something like
>
> src/main/docs
>   - readme.md  - a summary of what this maven module is, and what
> components / data formats etc it contains, and has links to the
> content below
>   + components   - directory for components
>   + languages - directory for languages
>   + dataformats - directory for data formats
>   + models   - directory for EIPs (only for camel-core)
>

The readme file could also be in the root directory of the component
so its easy browseable asap in github etc. Or when people look at the
source code there is a readme file. So the structure is

* readme.adoc  - a summary of what this maven module is, and what
included (with links to the docs in src/main/docs)

src/main/docs
   + components / data formats etc it contains, and has links to the
content below
   + components   - directory for components
   + languages - directory for languages
   + dataformats - directory for data formats
   + models   - directory for EIPs (only for camel-core)




>
>
>
> On Wed, Apr 6, 2016 at 9:33 AM, Claus Ibsen <cl...@gmail.com> wrote:
>> Hi
>>
>> I added a report output when building camel-catalog, that prints which
>> camel component modules that do not have any src/main/docs files.
>>
>> This can help us keep an eye on how many we have yet to do.
>>
>> Mind it only reports on directory level. So if a module has such as 3
>> components then it will report it as not missing if there is 1 adoc
>> file. But when you build the said module then it logs a WARN if any
>> Camel component do not have any adoc file.
>>
>> Here is just a snippet
>>
>> [WARNING] Missing document detected: 78
>> [WARNING] camel-ahc
>> [WARNING] camel-ahc-ws
>> [WARNING] camel-amqp
>> [WARNING] camel-apns
>> [WARNING] camel-atmosphere-websocket
>> [WARNING] camel-atom
>> [WARNING] camel-avro
>> [WARNING] camel-aws
>> [WARNING] camel-bam
>>
>> You can try with
>>
>> mvn clean install
>>
>> in the platforms/catalog directory.
>>
>>
>>
>>
>> --
>> Claus Ibsen
>> -----------------
>> http://davsclaus.com @davsclaus
>> Camel in Action 2: https://www.manning.com/ibsen2
>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2



-- 
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2

Re: Camel component docs - What is missing

Posted by Claus Ibsen <cl...@gmail.com>.
And btw we should consider a structure naming for the src/main/docs
folder so we can differentiate what the docs are for as a Maven module
may include both components / data formats / languages etc.

So I would consider doing something like

src/main/docs
  - readme.md  - a summary of what this maven module is, and what
components / data formats etc it contains, and has links to the
content below
  + components   - directory for components
  + languages - directory for languages
  + dataformats - directory for data formats
  + models   - directory for EIPs (only for camel-core)




On Wed, Apr 6, 2016 at 9:33 AM, Claus Ibsen <cl...@gmail.com> wrote:
> Hi
>
> I added a report output when building camel-catalog, that prints which
> camel component modules that do not have any src/main/docs files.
>
> This can help us keep an eye on how many we have yet to do.
>
> Mind it only reports on directory level. So if a module has such as 3
> components then it will report it as not missing if there is 1 adoc
> file. But when you build the said module then it logs a WARN if any
> Camel component do not have any adoc file.
>
> Here is just a snippet
>
> [WARNING] Missing document detected: 78
> [WARNING] camel-ahc
> [WARNING] camel-ahc-ws
> [WARNING] camel-amqp
> [WARNING] camel-apns
> [WARNING] camel-atmosphere-websocket
> [WARNING] camel-atom
> [WARNING] camel-avro
> [WARNING] camel-aws
> [WARNING] camel-bam
>
> You can try with
>
> mvn clean install
>
> in the platforms/catalog directory.
>
>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2



-- 
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2