This is an automated email from the ASF dual-hosted git repository.
jamesnetherton pushed a commit to branch 3.15.x
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
The following commit(s) were added to refs/heads/3.15.x by this push:
new fb91510c11 Remove incorrect assumptions about kamelets-catalog
dependency scope from the extension documentation
fb91510c11 is described below
commit fb91510c1110959d0e23c51c5a1a412573a89724
Author: James Netherton <jamesnether...@gmail.com>
AuthorDate: Thu Oct 3 10:29:58 2024 +0100
Remove incorrect assumptions about kamelets-catalog dependency scope from
the extension documentation
---
docs/modules/ROOT/pages/reference/extensions/kamelet.adoc | 12 +++++++-----
extensions/kamelet/runtime/src/main/doc/usage.adoc | 10 ++++++----
2 files changed, 13 insertions(+), 9 deletions(-)
diff --git a/docs/modules/ROOT/pages/reference/extensions/kamelet.adoc
b/docs/modules/ROOT/pages/reference/extensions/kamelet.adoc
index 457d992625..dc7d3358d4 100644
--- a/docs/modules/ROOT/pages/reference/extensions/kamelet.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/kamelet.adoc
@@ -46,16 +46,18 @@ endif::[]
[id="extensions-kamelet-usage"]
== Usage
-[id="extensions-kamelet-usage-pre-load-kamelets-at-build-time"]
-=== Pre-load Kamelets at build-time
+[id="extensions-kamelet-usage-preloading-kamelets-at-build-time"]
+=== Preloading Kamelets at build-time
-This extension allows to pre-load a set of Kamelets at build time using the
`quarkus.camel.kamelet.identifiers` property.
+This extension can preload a set of Kamelets at build time. You must include
the names of each Kamelet, in the `quarkus.camel.kamelet.identifiers`
configuration property.
[id="extensions-kamelet-usage-using-the-kamelet-catalog"]
=== Using the Kamelet Catalog
A set of pre-made Kamelets can be found on the /camel-kamelets/latest[Kamelet
Catalog].
-To use the Kamelet from the catalog you need to copy their yaml definition
(that you can find https://github.com/apache/camel-kamelets/[in the
camel-kamelet repo]) on your project in the classpath. Alternatively you can
add the `camel-kamelets-catalog` artifact to your `pom.xml`:
+To use a Kamelet from the catalog, you need to copy its YAML definition (that
you can find https://github.com/apache/camel-kamelets/[in the camel-kamelets
repository]) to your project.
+
+Alternatively, you can add a `camel-kamelets-catalog` dependency to your
application.
[source,xml]
----
@@ -65,7 +67,7 @@ To use the Kamelet from the catalog you need to copy their
yaml definition (that
</dependency>
----
-This artifact add all the kamelets available in the catalog to your Camel
Quarkus application for build time processing. If you include it with the scope
`provided` the artifact should not be part of the runtime classpath, but at
build time, all the kamelets listed via `quarkus.camel.kamelet.identifiers`
property should be preloaded.
+You can select which Kamelets from the catalog you want to use by referencing
their name in the `quarkus.camel.kamelet.identifiers` property.
[id="extensions-kamelet-additional-camel-quarkus-configuration"]
diff --git a/extensions/kamelet/runtime/src/main/doc/usage.adoc
b/extensions/kamelet/runtime/src/main/doc/usage.adoc
index 5ec1718e28..b5a3c00938 100644
--- a/extensions/kamelet/runtime/src/main/doc/usage.adoc
+++ b/extensions/kamelet/runtime/src/main/doc/usage.adoc
@@ -1,11 +1,13 @@
-=== Pre-load Kamelets at build-time
+=== Preloading Kamelets at build-time
-This extension allows to pre-load a set of Kamelets at build time using the
`quarkus.camel.kamelet.identifiers` property.
+This extension can preload a set of Kamelets at build time. You must include
the names of each Kamelet, in the `quarkus.camel.kamelet.identifiers`
configuration property.
=== Using the Kamelet Catalog
A set of pre-made Kamelets can be found on the /camel-kamelets/latest[Kamelet
Catalog].
-To use the Kamelet from the catalog you need to copy their yaml definition
(that you can find https://github.com/apache/camel-kamelets/[in the
camel-kamelet repo]) on your project in the classpath. Alternatively you can
add the `camel-kamelets-catalog` artifact to your `pom.xml`:
+To use a Kamelet from the catalog, you need to copy its YAML definition (that
you can find https://github.com/apache/camel-kamelets/[in the camel-kamelets
repository]) to your project.
+
+Alternatively, you can add a `camel-kamelets-catalog` dependency to your
application.
[source,xml]
----
@@ -15,4 +17,4 @@ To use the Kamelet from the catalog you need to copy their
yaml definition (that
</dependency>
----
-This artifact add all the kamelets available in the catalog to your Camel
Quarkus application for build time processing. If you include it with the scope
`provided` the artifact should not be part of the runtime classpath, but at
build time, all the kamelets listed via `quarkus.camel.kamelet.identifiers`
property should be preloaded.
+You can select which Kamelets from the catalog you want to use by referencing
their name in the `quarkus.camel.kamelet.identifiers` property.
