You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by GitBox <gi...@apache.org> on 2020/08/21 10:35:22 UTC
[GitHub] [camel-quarkus] ppalaga opened a new issue #1557: Consider using Antora extensions to produce reference pages
ppalaga opened a new issue #1557:
URL: https://github.com/apache/camel-quarkus/issues/1557
Followup of https://github.com/apache/camel-quarkus/pull/1552
The reference pages
* https://camel.apache.org/camel-quarkus/latest/reference/index.html
* https://camel.apache.org/camel-quarkus/latest/reference/components.html
* https://camel.apache.org/camel-quarkus/latest/reference/dataformats.html
* https://camel.apache.org/camel-quarkus/latest/reference/languages.html
* https://camel.apache.org/camel-quarkus/latest/reference/others.html
are currently produced by `camel-quarkus-maven-plugin` out of the camel catalog data in `catalog/target/classes/org/apache/camel/catalog/quarkus`
@djencks mentioned that we could use Antora extensions to produce these pages.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] djencks commented on issue #1557: Consider using Antora extensions to produce reference pages
Posted by GitBox <gi...@apache.org>.
djencks commented on issue #1557:
URL: https://github.com/apache/camel-quarkus/issues/1557#issuecomment-678390554
I started looking into this. To generate these pages' content with Antora we'd need to add the data shown in the tables to the extension .adoc files as header attributes, as is done for the main camel components/data formats/languages/.... .adoc files.
Is there any objection to doing this? If not I'll start looking in to how to do it.
I don't quite understand the criteria for inclusion in one or more of these pages, it would be helpful if it could be explained in words :-). My impression is that all extensions are listed in index.adoc, and also listed in exactly one of the other pages depending on the kind of the first scheme. (I'm not quite sure what that is, but can presumably figure it out).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] ppalaga commented on issue #1557: Consider using Antora extensions to produce reference pages
Posted by GitBox <gi...@apache.org>.
ppalaga commented on issue #1557:
URL: https://github.com/apache/camel-quarkus/issues/1557#issuecomment-678422616
I guess you mean these attributes? https://github.com/apache/camel/blame/master/docs/components/modules/dataformats/pages/any23-dataformat.adoc#L6-L9
That would have to be done in these FreeMarker templates:
* https://github.com/apache/camel-quarkus/blob/master/tooling/maven-plugin/src/main/resources/doc-templates/camel-kind.adoc.ftl#L3
* https://github.com/apache/camel-quarkus/blob/master/tooling/maven-plugin/src/main/resources/doc-templates/extensions.adoc.ftl#L4
And in the Maven mojo that is processing the templates in case we need to pass more data to the templates: https://github.com/apache/camel-quarkus/blob/master/tooling/maven-plugin/src/main/java/org/apache/camel/quarkus/maven/UpdateExtensionDocPageMojo.java#L88-L101
> Is there any objection to doing this?
Please go ahead!
> I don't quite understand the criteria for inclusion in one or more of these pages, it would be helpful if it could be explained in words :-). My impression is that all extensions are listed in index.adoc,
Yes, all "listed" ones. We also have some internal and test extensions that we do not list there.
> and also listed in exactly one of the other pages depending on the kind of the first scheme.
Yes, the entries in camel catalogs are organized by `kind`. The kinds are: components, data formats, languages and others. Camel uses some more kinds that we do not have in Camel Quarkus.
One extension can contain several Camel features of distinct kinds. E.g. the flatpack extension contains the flatpack component and flatpack data format: https://camel.apache.org/camel-quarkus/latest/reference/extensions/flatpack.html
So it is listed both under components https://camel.apache.org/camel-quarkus/latest/reference/components.html and under data formats: https://camel.apache.org/camel-quarkus/latest/reference/dataformats.html
Feel free to ask if you have more questions.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] ppalaga commented on issue #1557: Use asciidoctor-antora-indexer to produce lists of extensions and components on the reference pages
Posted by GitBox <gi...@apache.org>.
ppalaga commented on issue #1557:
URL: https://github.com/apache/camel-quarkus/issues/1557#issuecomment-692754636
FIxed via #1777
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] ppalaga commented on issue #1557: Consider using Antora extensions to produce reference pages
Posted by GitBox <gi...@apache.org>.
ppalaga commented on issue #1557:
URL: https://github.com/apache/camel-quarkus/issues/1557#issuecomment-690326944
I have a PoC that I'd like get feedback about shortly.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] ppalaga closed issue #1557: Use asciidoctor-antora-indexer to produce lists of extensions and components on the reference pages
Posted by GitBox <gi...@apache.org>.
ppalaga closed issue #1557:
URL: https://github.com/apache/camel-quarkus/issues/1557
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] djencks commented on issue #1557: Consider using Antora extensions to produce reference pages
Posted by GitBox <gi...@apache.org>.
djencks commented on issue #1557:
URL: https://github.com/apache/camel-quarkus/issues/1557#issuecomment-690440119
I got thoroughly distracted from this. I expect I can take a look at your PoC though!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] ppalaga commented on issue #1557: Consider using Antora extensions to produce reference pages
Posted by GitBox <gi...@apache.org>.
ppalaga commented on issue #1557:
URL: https://github.com/apache/camel-quarkus/issues/1557#issuecomment-690695650
> I got thoroughly distracted from this. I expect I can take a look at your PoC though!
No problem. It would be great if you could please comment on https://github.com/apache/camel-quarkus/pull/1777
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] ppalaga commented on issue #1557: Consider using Antora extensions to produce reference pages
Posted by GitBox <gi...@apache.org>.
ppalaga commented on issue #1557:
URL: https://github.com/apache/camel-quarkus/issues/1557#issuecomment-690109344
Any progress on this, @djencks ? I'd give this a try because of https://github.com/apache/camel-quarkus/issues/1770 unless you are in the middle of it?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org