camel-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Claus Ibsen <claus.ib...@gmail.com>
Subject Re: Camel component docs - What is missing
Date Wed, 06 Apr 2016 07:38:18 GMT
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 <claus.ibsen@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

Mime
View raw message