I’m inclined to think many of the component pages are already long enough to be 
extremely difficult to use.

Having separate pages in camel-quarkus would make constructing an index page 
using my antora-indexer extension very easy rather than more or less impossible 
:-)

I think I might like the “main” component page to just have the “main” 
component info, plus links (perhaps at the top) to all the other related info, 
for quarkus, spring-boot, etc.  Perhaps the existence of this related 
information could get into the .json file and used to construct the links 
automatically.

Thanks
David Jencks

> On Apr 27, 2020, at 9:17 AM, Peter Palaga <ppal...@redhat.com> wrote:
> 
> Hi,
> 
> We currently have manually curated per-Camel-Quarkus-extension pages rather 
> rarely, esp. when there is some additional config option or important 
> difference between the given Camel Quarkus extension and the underlying Camel 
> component. Here are some examples:
> 
> * https://camel.apache.org/camel-quarkus/latest/extensions/ahc.html
> * https://camel.apache.org/camel-quarkus/latest/extensions/couchdb.html
> * https://camel.apache.org/camel-quarkus/latest/extensions/dozer.html
> * https://camel.apache.org/camel-quarkus/latest/extensions/fhir.html
> * https://camel.apache.org/camel-quarkus/latest/extensions/graphql.html
> 
> Are separate Camel Quarkus pages actually the best way to document additional 
> config options, important differences against vanilla Camel and showing the 
> Maven coordinates for the given extension?
> 
> Luca pointed out today that Spring Boot starter info is listed directly in 
> the Camel component pages and that Camel Quarkus info should probably go 
> there too.
> I must say I find the component pages long enough already. I am not sure 
> bloating them even more with the Camel Quarkus stuff would bring enough value 
> to the users. Does actually anybody think this would be the way to go?
> 
> Per-extension pages are handy for one more reason: Quarkus metadata for 
> http://code.quarkus.io/ requires a link that is used there to open "a guide" 
> for the given extension.
> 
> We currently use https://quarkus.io/guides/camel for all our extensions. 
> That's far from being user friendly. Having a page for each Camel Quarkus 
> extension would be much better I think.
> 
> I'd appreciate any feedback.
> 
> Thanks,
> 
> -- Peter
> 

Reply via email to