This is an automated email from the ASF dual-hosted git repository.
ppalaga pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
commit 0ee95d5f0f7fde524397b1d184e083ca1879a122
Author: Peter Palaga <ppal...@redhat.com>
AuthorDate: Thu May 21 23:02:34 2020 +0200
Fix #1243 Document how quarkus-extemsion.yaml is generated
---
docs/modules/ROOT/nav.adoc | 7 +++--
docs/modules/ROOT/pages/extension-metadata.adoc | 41 +++++++++++++++++++++++++
2 files changed, 45 insertions(+), 3 deletions(-)
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index aba8308..97a457b 100644
--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@@ -4,8 +4,9 @@
** xref:native-mode.adoc[Native mode]
** xref:examples.adoc[Examples]
* xref:contributor-guide.adoc[Contributor guide]
-** xref:create-new-extension.adoc[Create new extension].
-** xref:promote-jvm-to-native.adoc[Promote JVM extension to Native].
-** xref:ci.adoc[Camel Quarkus Continuous Integration Builds]
+** xref:create-new-extension.adoc[Create new extension]
+** xref:promote-jvm-to-native.adoc[Promote JVM extension to Native]
+** xref:extension-metadata.adoc[Extension metadata]
+** xref:ci.adoc[Continuous Integration]
** xref:release-guide.adoc[Release guide]
* xref:list-of-camel-quarkus-extensions.adoc[List of Camel Quarkus extensions]
diff --git a/docs/modules/ROOT/pages/extension-metadata.adoc
b/docs/modules/ROOT/pages/extension-metadata.adoc
new file mode 100644
index 0000000..1a349e2
--- /dev/null
+++ b/docs/modules/ROOT/pages/extension-metadata.adoc
@@ -0,0 +1,41 @@
+= Extension metadata
+
+== `quarkus-extension.yaml`
+
+This file contains metadata used by Quarkus project generator
https://code.quarkus.io/[https://code.quarkus.io/].
+It is located in the `src/main/resources/META-INF` directory of the runtime
module.
+Here is an
https://github.com/apache/camel-quarkus/blob/master/extensions/activemq/runtime/src/main/resources/META-INF/quarkus-extension.yaml[example
from the ActiveMQ extension]:
+
+[source,yaml]
+----
+name: "Camel ActiveMQ"
+description: "Send messages to (or consume from) Apache ActiveMQ. This
component extends the Camel JMS component"
+metadata:
+ guide:
"https://camel.apache.org/camel-quarkus/latest/extensions/activemq.html";
+ categories:
+ - "integration"
+----
+
+Within Camel Quarkus, these files are 100% generated by `cq-maven-plugin`. To
re-generate the
+`quarkus-extension.yaml` files in the whole source tree, run the following
command from the root directory of
+the source tree:
+
+[source,shell]
+----
+$ mvn -N cq:update-quarkus-metadata
+----
+
+The data comes from the following
+sources:
+
+* `name`: comes from `pom.xml`'s `<name>`
+* `description`: taken from
https://camel.apache.org/manual/latest/camel-catalog.html[Camel Catalog]. If
the given
+ extension contains more than one component, language or data format, their
descriptions are concatenated and a warning
+ is issued in the log. The value from Camel Catalog can be overridden by
setting a `<description>` in the
+ `pom.xml` of the given extension's runtime module.
+* `guide`: derived from the extension's `artifactId`
+* `unlisted`: `true` if the given extension is JVM only; omitted otherwise.
+* `keywords`: omitted unless `<quarkus.metadata.keywords>` property is
available in the runtime module's
+ `pom.xml` file. Please set explicit keywords only if the given term is both
important and occurs neither in
+ extension name nor in the description.
+* `categories`: constant
