Skip to content

Commit

Permalink
Remove incorrect assumptions about kamelets-catalog dependency scope …
Browse files Browse the repository at this point in the history
…from the extension documentation
  • Loading branch information
jamesnetherton committed Oct 4, 2024
1 parent 98a716c commit 02a992e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
12 changes: 7 additions & 5 deletions docs/modules/ROOT/pages/reference/extensions/kamelet.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand All @@ -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"]
Expand Down
10 changes: 6 additions & 4 deletions extensions/kamelet/runtime/src/main/doc/usage.adoc
Original file line number Diff line number Diff line change
@@ -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]
----
Expand All @@ -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.

0 comments on commit 02a992e

Please sign in to comment.