This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit cae9c4277a03f0b504f095e22b6fb80196f9de32
Author: Otavio Rodolfo Piske <angusyo...@gmail.com>
AuthorDate: Wed Feb 21 08:21:16 2024 +0100
CAMEL-20410: documentation fixes for camel-ignite
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/ignite-cache-component.adoc | 2 +-
.../src/main/docs/ignite-events-component.adoc | 2 +-
.../src/main/docs/ignite-idgen-component.adoc | 2 +-
.../src/main/docs/ignite-messaging-component.adoc | 2 +-
.../src/main/docs/ignite-queue-component.adoc | 2 +-
.../src/main/docs/ignite-set-component.adoc | 2 +-
.../camel-ignite/src/main/docs/ignite-summary.adoc | 27 ++++++++++++----------
7 files changed, 21 insertions(+), 18 deletions(-)
diff --git a/components/camel-ignite/src/main/docs/ignite-cache-component.adoc
b/components/camel-ignite/src/main/docs/ignite-cache-component.adoc
index 41a890ced25..be3d6840a38 100644
--- a/components/camel-ignite/src/main/docs/ignite-cache-component.adoc
+++ b/components/camel-ignite/src/main/docs/ignite-cache-component.adoc
@@ -15,7 +15,7 @@
*{component-header}*
-The Ignite Cache endpoint is one of camel-ignite endpoints which allows you to
interact with an https://apacheignite.readme.io/docs/data-grid[Ignite Cache].
+The Ignite Cache endpoint is one of camel-ignite endpoints that allow you to
interact with an https://apacheignite.readme.io/docs/data-grid[Ignite Cache].
This offers both a Producer (to invoke cache operations on an Ignite cache)
and a Consumer (to consume changes from a continuous query).
The cache value is always the body of the message, whereas the cache key is
always stored in the `IgniteConstants.IGNITE_CACHE_KEY` message header.
diff --git a/components/camel-ignite/src/main/docs/ignite-events-component.adoc
b/components/camel-ignite/src/main/docs/ignite-events-component.adoc
index accc047322f..c8090bf59df 100644
--- a/components/camel-ignite/src/main/docs/ignite-events-component.adoc
+++ b/components/camel-ignite/src/main/docs/ignite-events-component.adoc
@@ -17,7 +17,7 @@
The Ignite Events endpoint is one of camel-ignite endpoints which allows you
to https://apacheignite.readme.io/docs/events[receive events] from the Ignite
cluster by creating a local event listener.
-The Exchanges created by this consumer put the received Event object into the
body of the IN message.
+The Exchanges created by this consumer put the received Event object into the
body of the _IN_ message.
// component-configure options: START
diff --git a/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc
b/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc
index 12e356e2234..09aa98b6608 100644
--- a/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc
+++ b/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc
@@ -15,7 +15,7 @@
*{component-header}*
-The Ignite ID Generator endpoint is one of camel-ignite endpoints which allows
you to interact with https://apacheignite.readme.io/docs/id-generator[Ignite
Atomic Sequences and ID Generators].
+The Ignite ID Generator endpoint is one of camel-ignite endpoints that allow
you to interact with https://apacheignite.readme.io/docs/id-generator[Ignite
Atomic Sequences and ID Generators].
// component-configure options: START
diff --git
a/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc
b/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc
index 08d2605ef06..897b287e72f 100644
--- a/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc
+++ b/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc
@@ -15,7 +15,7 @@
*{component-header}*
-The Ignite Messaging endpoint is one of camel-ignite endpoints which allows
you to send and consume messages from an
https://apacheignite.readme.io/docs/messaging[Ignite topic].
+The Ignite Messaging endpoint is one of camel-ignite endpoints that allow you
to send and consume messages from an
https://apacheignite.readme.io/docs/messaging[Ignite topic].
// component-configure options: START
diff --git a/components/camel-ignite/src/main/docs/ignite-queue-component.adoc
b/components/camel-ignite/src/main/docs/ignite-queue-component.adoc
index ac8611dabf6..07496a9bedc 100644
--- a/components/camel-ignite/src/main/docs/ignite-queue-component.adoc
+++ b/components/camel-ignite/src/main/docs/ignite-queue-component.adoc
@@ -15,7 +15,7 @@
*{component-header}*
-The Ignite Queue endpoint is one of camel-ignite endpoints which allows you to
interact with https://apacheignite.readme.io/docs/queue-and-set[Ignite Queue
data structures].
+The Ignite Queue endpoint is one of camel-ignite endpoints that allow you to
interact with https://apacheignite.readme.io/docs/queue-and-set[Ignite Queue
data structures].
// component-configure options: START
diff --git a/components/camel-ignite/src/main/docs/ignite-set-component.adoc
b/components/camel-ignite/src/main/docs/ignite-set-component.adoc
index 9b4af41c83f..b15b53a6a2d 100644
--- a/components/camel-ignite/src/main/docs/ignite-set-component.adoc
+++ b/components/camel-ignite/src/main/docs/ignite-set-component.adoc
@@ -15,7 +15,7 @@
*{component-header}*
-The Ignite Sets endpoint is one of camel-ignite endpoints which allows you to
interact with https://apacheignite.readme.io/docs/queue-and-set[Ignite Set data
structures].
+The Ignite Sets endpoint is one of camel-ignite endpoints that allows you to
interact with https://apacheignite.readme.io/docs/queue-and-set[Ignite Set data
structures].
// component-configure options: START
diff --git a/components/camel-ignite/src/main/docs/ignite-summary.adoc
b/components/camel-ignite/src/main/docs/ignite-summary.adoc
index 0f067053bb6..937a254a29e 100644
--- a/components/camel-ignite/src/main/docs/ignite-summary.adoc
+++ b/components/camel-ignite/src/main/docs/ignite-summary.adoc
@@ -7,7 +7,7 @@
*Since Camel {since}*
-https://ignite.apache.org/[Apache Ignite] In-Memory Data Fabric is a
high-performance, integrated and distributed in-memory platform for computing
and transacting on large-scale data sets in real-time, orders of magnitude
faster than possible with traditional disk-based or flash technologies. It is
designed to deliver uncompromised performance for a wide set of in-memory
computing use cases from high performance computing, to the industry most
advanced data grid, highly available service [...]
+https://ignite.apache.org/[Apache Ignite] In-Memory Data Fabric is a high
performance, integrated and distributed in-memory platform for computing and
transacting on large-scale data sets in real-time, orders of magnitude faster
than possible with traditional disk-based or flash technologies. It is designed
to deliver uncompromised performance for a wide set of in-memory computing use
cases from high-performance computing, to the industry's most advanced data
grid, highly available servi [...]
image::apache-ignite.png[]
@@ -20,7 +20,7 @@
indexDescriptionList::[attributes='group={doctitle}',descriptionformat=descripti
== Installation
-To use this component, add the following dependency to your pom.xml:
+To use this component, add the following dependency to your `pom.xml`:
[source,xml]
----
@@ -37,9 +37,11 @@ IMPORTANT: If running in an OSGi container, please consult
the <<Ignite-OsgiSupp
== Initializing the Ignite component
-Each instance of the Ignite component is associated with an underlying
org.apache.ignite.Ignite instance. You can interact with two Ignite clusters by
initializing two instances of the Ignite component and binding them to
different IgniteConfigurations. There are 3 ways to initialize the Ignite
component:
+Each instance of the Ignite component is associated with an underlying
`org.apache.ignite.Ignite` instance.
+You can interact with two Ignite clusters by initializing two instances of the
Ignite component and binding them to different `IgniteConfigurations`.
+There are three ways to initialize the Ignite component:
-* By passing in an existing org.apache.ignite.Ignite instance. Here's an
example using Spring config:
+* By passing in an existing `org.apache.ignite.Ignite` instance. Here's an
example using Spring config:
[source,xml]
------------------------------------------------------------
@@ -48,7 +50,8 @@ Each instance of the Ignite component is associated with an
underlying org.apach
</bean>
------------------------------------------------------------
-* By passing in an IgniteConfiguration, either constructed programmatically or
through inversion of control (e.g. Spring, Blueprint, etc.). Here's an example
using Spring config:
+* By passing in an IgniteConfiguration, either constructed programmatically or
through inversion of control (e.g., Spring, Blueprint, etc).
+Here's an example using Spring config:
[source,xml]
-------------------------------------------------------------------
@@ -70,13 +73,13 @@ Each instance of the Ignite component is associated with an
underlying org.apach
</bean>
-------------------------------------------------------------------
-Additionally, if using Camel programmatically, there are several convenience
static methods in IgniteComponent that return a component out of any of these
configuration options:
+Additionally, if using Camel programmatically, there are several convenience
static methods in IgniteComponent that return a component out of these
configuration options:
-* IgniteComponent#fromIgnite(Ignite)
-* IgniteComponent#fromConfiguration(IgniteConfiguration)
-* IgniteComponent#fromInputStream(InputStream)
-* IgniteComponent#fromUrl(URL)
-* IgniteComponent#fromLocation(String)
+* `IgniteComponent#fromIgnite(Ignite)`
+* `IgniteComponent#fromConfiguration(IgniteConfiguration)`
+* `IgniteComponent#fromInputStream(InputStream)`
+* `IgniteComponent#fromUrl(URL)`
+* `IgniteComponent#fromLocation(String)`
You may use those methods to quickly create an IgniteComponent with your
chosen configuration technique.
@@ -87,7 +90,7 @@ All endpoints share the following options:
|=======================================================================
| Option | Type | Default value | Description
| propagateIncomingBodyIfNoReturnValue | boolean | true |
-If the underlying Ignite operation returns void (no return type), this flag
determines whether the producer will copy the IN body into the OUT body.
+If the underlying Ignite operation returns void (no return type), this flag
determines whether the producer will copy the _IN_ body into the _OUT_ body.
| treatCollectionsAsCacheObjects | boolean | false |
Some Ignite operations can deal with multiple elements at once, if passed a
Collection. Enabling this option will treat Collections as a single object,
invoking the operation variant for cardinality 1.
