> On Nov 6, 2021, at 11:44 PM, Claus Ibsen <claus.ib...@gmail.com> wrote:
>
> Hi
>
> The -starter JARs in camel-spring-boot no longer have docs, only a json file.
>
> There are a few starter JARs where we need to add some special
> documentation. How should we do this now?
>
> In camel-quarkus they seems to be able to drop in usage.adoc /
> limitations.adoc file
> https://github.com/apache/camel-quarkus/tree/main/extensions/activemq/runtime/src/main/doc
>
> Maybe we need something similar?
>
> If so it would also make the docs similar between these two sub projects.
I have a plan to generate the camel-quarkus docs differently, during the Antora
build. I’m trying out the basis of the method on camel-kafka-connector and
hope to have something to show in a day or two.
Let’s try to pin down the requirements for camel-spring-boot a little more…
1. The camel-spring-boot docs never appear standalone, but always included at
the end of main camel doc pages. So, if the extra content should appear before
or after the existing content, one easy solution that doesn’t require changes
in generation is to put the additional content in partials and manually add
includes of it to the main camel doc page. If there will ever only be a few
such camel-spring-boot projects needing extra documentation I’d recommend
seriously considering this solution: it has the advantage of being very
low-tech and visible.
2. If the additional doc bits need to be in the middle of the camel-spring-boot
section, or if there are a lot of components needing additional docs, then a
more automated solution would be appropriate. Here there are several choices as
well.
2.a. If the additional content can just be included without any added section
headers or other wrapping, then putting it in appropriately located and named
partials and including it with an optional include in the template will work.
2.b. If the additional content needs to be wrapped with e.g. a section header,
as camel-quarkus does, then something more complicated is needed. I think I
know how to get Antora to assemble stuff as camel-quarkus does, but I won’t get
to trying it for a few days.
David Jencks
>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2
