Sure, we can do that.
However, I was thinking would it make sense in the long run to combine all
examples in one repo? What I mean examples for camel-spring, camel-quarkus,
camel-k and camel-kafka-connect?  then we can change the structure of repo
a bit to have submodules for each project example. What do you guys think?

On Tue, Feb 11, 2020 at 12:55 PM Claus Ibsen <claus.ib...@gmail.com> wrote:

> On Tue, Feb 11, 2020 at 12:49 PM Omar Al-Safi <o...@oalsafi.com> wrote:
> >
> > Hello folks,
> >
> > Short update on the camel-examples. So now we have the repo for the
> > camel-examples setup and compiled, also a basic github workflow is being
> > added to build the project.
> > However, the only missing piece, is to generate the docs for the examples
> > from the new repo instead of the current one that generate the examples
> > from the main repo using a relative path.
> >
>
> Yeah sounds good.
>
> For the docs generation of the readme, then you can port over the
> maven tools there is a maven mojo that does this.
>
> And then another big task is to use Camel BOM for the examples. Today
> they refer to a parent pom. We should maybe do a BOM import on each
> example.
>
>
>
> > Regards,
> > Omar
> >
> > On Tue, Feb 11, 2020 at 10:00 AM Claus Ibsen <claus.ib...@gmail.com>
> wrote:
> >
> > > On Tue, Feb 11, 2020 at 9:49 AM Zoran Regvart <zo...@regvart.com>
> wrote:
> > > >
> > > > Hi Cameleers,
> > > > I'll have a look at the docs + website today and see how far do I go.
> > > >
> > > > On Mon, Feb 10, 2020 at 2:15 PM Claus Ibsen <claus.ib...@gmail.com>
> > > wrote:
> > > > > a) Add docs to camel-spring-boot with the docs website, ala spring
> > > > > quarkus. Zoran can you help with this?
> > > >
> > > > Yup, it's on my todo for today as well as the camel-kafka-connector
> docs
> > > >
> > > > > b) Add Camel Spring Boot as a menu item to the Projects menu item
> on
> > > the website
> > > >
> > > > Yup
> > > >
> > > > > c) Add a few docs page for Camel Spring Boot ala Camel Quarkus
> > > >
> > > > I can create placeholders for the docs, or are there any existing
> docs
> > > > that I can reuse here?
> > > >
> > >
> > > Not really, the docs are primary in the camel-spring-boot component
> > >
> > >
> https://github.com/apache/camel-spring-boot/blob/master/core/camel-spring-boot/src/main/docs/spring-boot.adoc
> > >
> > > But lets start with a fresh and have a bit like camel-quarkus, where
> > > we have a clean front page.
> > > And then a link to "extensions" which are starters in spring lingo.
> > > And then we can have a link to the page above for the "main spring
> boot'
> > > docs.
> > > Then over time we can iterate and improve this doc. Hopefully
> > > community users step up and help too.
> > >
> > > > > d) List all the Camel Spring Boot Starters in a page, and have 2
> > > > > links: one for auto configuration and another to point to the
> > > > > component docs on the main website.
> > > >
> > > > I guess this can be based on the README.adoc[1]?
> > > >
> > >
> > > Yeah the tool works like in camel-quarkus. So if we have a page
> > > docs/modules/ROOT/pages/list-of-camel-spring-boot-components.adoc
> > >
> > > Then the tool will update that page too. So what we need to do is to
> > > adjust the tool to add the links for auto configuration.
> > > (its this maven plugin UpdateDocComponentsListMojo)
> > >
> > > > > e) We can look at to see if we can find out a way to inline the
> spring
> > > > > boot auto configuration docs in the main docs so they are listed
> there
> > > > > again (but then non SB users have docs that are convoluted with
> SB).
> > > > > If we dont do this, then we have a nice clear separation and people
> > > > > can see the SB docs on the "Camel Spring Boot" project docs.
> > > >
> > > > David pointed out that this can be done, i.e. have two git
> > > > repositories contribute to the same Antora component, I need to look
> > > > into that, might be a bit of work, most likely towards the end of the
> > > > week.
> > > >
> > > > zoran
> > > >
> > > > [1]
> > >
> https://github.com/apache/camel-spring-boot/blob/master/components-starter/README.adoc
> > > >
> > > > --
> > > > Zoran Regvart
> > >
> > >
> > >
> > > --
> > > 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
>

Reply via email to