You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by pp...@apache.org on 2021/07/28 19:39:43 UTC

[camel-quarkus] branch main updated: Polish the wording of the Configuration docs page

This is an automated email from the ASF dual-hosted git repository.

ppalaga pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git


The following commit(s) were added to refs/heads/main by this push:
     new f5dca17  Polish the wording of the Configuration docs page
f5dca17 is described below

commit f5dca17062098c44b710cbbabc56dfc3b7bc36fc
Author: Peter Palaga <pp...@redhat.com>
AuthorDate: Wed Jul 28 18:27:59 2021 +0200

    Polish the wording of the Configuration docs page
---
 .../ROOT/pages/user-guide/configuration.adoc       | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/docs/modules/ROOT/pages/user-guide/configuration.adoc b/docs/modules/ROOT/pages/user-guide/configuration.adoc
index 0bded8c..e378034 100644
--- a/docs/modules/ROOT/pages/user-guide/configuration.adoc
+++ b/docs/modules/ROOT/pages/user-guide/configuration.adoc
@@ -40,9 +40,9 @@ camel.component.log.exchange-formatter.show-body-type = false
 
 === CDI
 
-The same can be done programmatically using CDI.
+You can also configure a component programmatically using CDI.
 
-The best way is to observe the `ComponentAddEvent` and configure the component before the routes and the `CamelContext` are started:
+The recommended method is to observe the `ComponentAddEvent` and configure the component before the routes and the `CamelContext` are started:
 
 [source,java]
 ----
@@ -69,19 +69,19 @@ public static class EventHandler {
 
 ==== Producing a `@Named` component instance
 
-Alternatively, you could create and configure the component yourself in a `@Named` producer method.
-This would work thanks to the fact that Camel uses the component URI scheme to look-up components from its registry.
-E.g. for `LogComponent` it would look for a `log` named bean.
+Alternatively, you can create and configure the component yourself in a `@Named` producer method.
+This works as Camel uses the component URI scheme to look-up components from its registry. For example, in the case of a `LogComponent` Camel looks for a `log` named bean.
 
 [WARNING]
 ====
-Please note that while producing a `@Named` component bean will work in most cases, it may cause subtle issues with some components.
+Please note that while producing a `@Named` component bean will usually work, it may cause subtle issues with some components.
+
 Camel Quarkus extensions may do one or more of the following:
-+
-* Pass custom subtype of the default Camel component type - see e.g. in https://github.com/apache/camel-quarkus/blob/main/extensions/vertx-websocket/runtime/src/main/java/org/apache/camel/quarkus/component/vertx/websocket/VertxWebsocketRecorder.java#L42[Vert.x WebSocket extension]
-* Perform some Quarkus specific customization of the component - see e.g. in https://github.com/apache/camel-quarkus/blob/main/extensions/jpa/runtime/src/main/java/org/apache/camel/quarkus/component/jpa/CamelJpaRecorder.java#L35[JPA extension].
-+
-All of these get lost when you produce your own component instance. Therefore configuring components in an observer method should be preferred.
+
+* Pass custom subtype of the default Camel component type. See the https://github.com/apache/camel-quarkus/blob/main/extensions/vertx-websocket/runtime/src/main/java/org/apache/camel/quarkus/component/vertx/websocket/VertxWebsocketRecorder.java#L42[Vert.x WebSocket extension] example.
+* Perform some Quarkus specific customization of the component. See the https://github.com/apache/camel-quarkus/blob/main/extensions/jpa/runtime/src/main/java/org/apache/camel/quarkus/component/jpa/CamelJpaRecorder.java#L35[JPA extension] example.
+
+These actions are not performed when you produce your own component instance, therefore, configuring components in an observer method is the recommended method.
 ====
 
 [source,java]