This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new c0b26ec01c3 CAMEL-20410: more fixes (#13220)
c0b26ec01c3 is described below
commit c0b26ec01c345d630f815a1efef055e826660c1c
Author: Otavio Rodolfo Piske <[email protected]>
AuthorDate: Tue Feb 20 19:28:48 2024 +0100
CAMEL-20410: more fixes (#13220)
* CAMEL-20410: documentation fixes for camel-zookeeper-master
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
* CAMEL-20410: documentation fixes for camel-zookeeper
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
* CAMEL-20410: documentation fixes for camel-zip-deflater
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
* CAMEL-20410: documentation fixes for camel-zendesk
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
* CAMEL-20410: documentation fixes for camel-zeebe
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../camel-zeebe/src/main/docs/zeebe-component.adoc | 4 ++--
.../src/main/docs/zendesk-component.adoc | 2 +-
.../src/main/docs/gzipDeflater-dataformat.adoc | 10 +++++-----
.../src/main/docs/zipDeflater-dataformat.adoc | 14 +++++++-------
.../src/main/docs/zookeeper-master-component.adoc | 20 ++++++++++----------
.../src/main/docs/zookeeper-component.adoc | 16 ++++++++--------
6 files changed, 33 insertions(+), 33 deletions(-)
diff --git a/components/camel-zeebe/src/main/docs/zeebe-component.adoc
b/components/camel-zeebe/src/main/docs/zeebe-component.adoc
index 8c56c7d5d56..f6bc7a7adc8 100644
--- a/components/camel-zeebe/src/main/docs/zeebe-component.adoc
+++ b/components/camel-zeebe/src/main/docs/zeebe-component.adoc
@@ -16,7 +16,7 @@
The *Zeebe*: components provides the ability to interact with business
processes in https://github.com/camunda/zeebe[Zeebe].
-In order to use the Zeebe component, Maven users will need to add the
+To use the Zeebe component, Maven users will need to add the
following dependency to their `pom.xml`:
[NOTE]
@@ -72,7 +72,7 @@ include::partial$component-endpoint-options.adoc[]
|=======================================================================
-The endpoints accept either Java request objects as shown in the examples
below or JSON. In JSON camel case for property names is replaced with all lower
case seperated by underscores, e.g. processId becomes process_id.
+The endpoints accept either Java request objects as shown in the examples
below or JSON. In JSON camel case for property names is replaced with all lower
case separated by underscores, e.g., processId becomes process_id.
*Examples*
diff --git a/components/camel-zendesk/src/main/docs/zendesk-component.adoc
b/components/camel-zendesk/src/main/docs/zendesk-component.adoc
index 956c837cac7..f6c1d55dcff 100644
--- a/components/camel-zendesk/src/main/docs/zendesk-component.adoc
+++ b/components/camel-zendesk/src/main/docs/zendesk-component.adoc
@@ -14,7 +14,7 @@
*{component-header}*
-The Zendesk component provides access to all of the zendesk.com APIs accessible
+The Zendesk component provides access to all the zendesk.com APIs accessible
using https://github.com/cloudbees/zendesk-java-client[zendesk-java-client]. It
allows producing messages to manage Zendesk ticket, user, organization, etc.
diff --git
a/components/camel-zip-deflater/src/main/docs/gzipDeflater-dataformat.adoc
b/components/camel-zip-deflater/src/main/docs/gzipDeflater-dataformat.adoc
index b3f3913d3ea..c75d7e89eb7 100644
--- a/components/camel-zip-deflater/src/main/docs/gzipDeflater-dataformat.adoc
+++ b/components/camel-zip-deflater/src/main/docs/gzipDeflater-dataformat.adoc
@@ -12,19 +12,19 @@
*Since Camel {since}*
The GZip Deflater Data Format is a message compression and
-de-compression format. It uses the same deflate algorithm that is used
+decompression format. It uses the same deflating algorithm used
in the Zip data format, although some additional
headers are provided. This format is produced by popular `gzip`/`gunzip`
tool. Messages marshalled using GZip compression can be unmarshalled
using GZip decompression just prior to being consumed at the endpoint.
The compression capability is quite useful when you deal with large XML
-and Text based payloads or when you read messages previously comressed
+and text-based payloads or when you read messages previously comressed
using `gzip` tool.
[NOTE]
====
This dataformat is not for working with gzip files such as uncompressing and
building gzip files.
-Instead use the zipfile dataformat.
+Instead, use the xref:zipfile-dataformat.adoc[zipfile] dataformat.
====
== Options
@@ -35,7 +35,7 @@ include::partial$dataformat-options.adoc[]
== Marshal
-In this example we marshal a regular text/XML payload to a compressed
+In this example, we marshal a regular text/XML payload to a compressed
payload employing gzip compression format and send it an ActiveMQ queue
called MY_QUEUE.
@@ -57,7 +57,7 @@
from("activemq:queue:MY_QUEUE").unmarshal().gzipDeflater().process(new UnGZipped
== Dependencies
-If you use Maven you could just add the following to your `pom.xml`,
substituting the version number for the latest and greatest release (see the
download page for the latest versions).
+If you use Maven you could add the following to your `pom.xml`, substituting
the version number for the latest and greatest release (see the download page
for the latest versions).
[source,xml]
---------------------------------------
diff --git
a/components/camel-zip-deflater/src/main/docs/zipDeflater-dataformat.adoc
b/components/camel-zip-deflater/src/main/docs/zipDeflater-dataformat.adoc
index b47c6dadee5..225e55aabc1 100644
--- a/components/camel-zip-deflater/src/main/docs/zipDeflater-dataformat.adoc
+++ b/components/camel-zip-deflater/src/main/docs/zipDeflater-dataformat.adoc
@@ -13,17 +13,17 @@
The Zip Deflater Data Format is a message compression and
-de-compression format. Messages marshalled using Zip compression can be
+decompression format. Messages marshaled using Zip compression can be
unmarshalled using Zip decompression just prior to being consumed at the
endpoint. The compression capability is quite useful when you deal with
large XML and Text based payloads. It facilitates more optimal use of
-network bandwidth while incurring a small cost in order to compress and
+network bandwidth while incurring a small cost to compress and
decompress payloads at the endpoint.
[NOTE]
====
This dataformat is not for working with zip files such as uncompressing and
building zip files.
-Instead use the zipfile dataformat.
+Instead, use the xref:zipfile-dataformat.adoc[zipfile] dataformat.
====
== Options
@@ -43,7 +43,7 @@ it an ActiveMQ queue called MY_QUEUE.
from("direct:start").marshal().zipDeflater(Deflater.BEST_COMPRESSION).to("activemq:queue:MY_QUEUE");
----
-Alternatively if you would like to use the default setting you could
+Alternatively, if you would like to use the default setting, you could
send it as
[source,java]
@@ -53,10 +53,10 @@
from("direct:start").marshal().zipDeflater().to("activemq:queue:MY_QUEUE");
== Unmarshal
-In this example we unmarshal a zipped payload from an ActiveMQ queue
+In this example, we unmarshal a zipped payload from an ActiveMQ queue
called MY_QUEUE to its original format, and forward it for processing to
the UnZippedMessageProcessor. Note that the compression Level employed
-during the marshalling should be identical to the one employed during
+during the marshaling should be identical to the one employed during
unmarshalling to avoid errors.
[source,java]
@@ -66,7 +66,7 @@
from("activemq:queue:MY_QUEUE").unmarshal().zipDeflater().process(new UnZippedMe
== Dependencies
-If you use Maven you could just add the following to your `pom.xml`,
substituting the version number for the latest and greatest release (see the
download page for the latest versions).
+If you use Maven you could add the following to your `pom.xml`, substituting
the version number for the latest and greatest release (see the download page
for the latest versions).
[source,xml]
---------------------------------------
diff --git
a/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc
b/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc
index ac7da274a95..2002262ec0a 100644
---
a/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc
+++
b/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc
@@ -15,14 +15,14 @@
*{component-header}*
The **zookeeper-master:** endpoint provides a way to ensure only a single
consumer in a cluster consumes from a given endpoint;
-with automatic failover if that JVM dies.
+with automatic fails over if that JVM dies.
-This can be very useful if you need to consume from some legacy back end which
either doesn't support concurrent
-consumption or due to commercial or stability reasons you can only have a
single connection at any point in time.
+This can be beneficial if you need to consume from some legacy back end that
either doesn't support concurrent
+consumption or due to commercial or stability reasons, you can only have a
single connection at any point in time.
== Using the master endpoint
-Just prefix any camel endpoint with **zookeeper-master:someName:** where
_someName_ is a logical name and is
+Prefix any camel endpoint with **zookeeper-master:someName:** where _someName_
is a logical name and is
used to acquire the master lock. e.g.
[source,java]
@@ -31,7 +31,7 @@ from("zookeeper-master:cheese:jms:foo").to("activemq:wine");
----
The above simulates the [Exclusive
Consumers](http://activemq.apache.org/exclusive-consumer.html) type feature in
-ActiveMQ; but on any third party JMS provider which maybe doesn't support
exclusive consumers.
+ActiveMQ; but on any third party JMS provider that maybe doesn't support
exclusive consumers.
== URI format
@@ -40,7 +40,7 @@ ActiveMQ; but on any third party JMS provider which maybe
doesn't support exclus
zookeeper-master:name:endpoint[?options]
----
-Where endpoint is any Camel endpoint you want to run in master/slave mode.
+Where endpoint is any Camel endpoint, you want to run in master/slave mode.
@@ -86,7 +86,7 @@ ZooKeeper will by default connect to `localhost:2181`, but
you can configure thi
master.setZooKeeperUrl("myzookeeper:2181");
----
-However you can also configure the url of the ZooKeeper ensemble using
environment variables.
+However, you can also configure the url of the ZooKeeper ensemble using
environment variables.
[source,bash]
----
@@ -97,10 +97,10 @@ export ZOOKEEPER_URL = "myzookeeper:2181"
You can also use a `RoutePolicy` to control routes in master/slave mode.
-When doing so you must configure the route policy with
+When doing so, you must configure the route policy with
- url to zookeeper ensemble
-- name of cluster group
+- name of the cluster group
- *important* and set the route to not auto startup
A little example
@@ -112,7 +112,7 @@ A little example
master.setGroupName("myGroup");
// its import to set the route to not auto startup
- // as we let the route policy start/stop the routes when it becomes a
master/slave etc
+ // as we let the route policy start/stop the routes when it becomes a
master/slave, etc.
from("file:target/inbox?delete=true").noAutoStartup()
// use the zookeeper master route policy in the clustered group
// to run this route in master/slave mode
diff --git a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
index 8c2fe85af0d..a62196611d8 100644
--- a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
+++ b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
@@ -21,7 +21,7 @@ following features to Camel:
1. Creation of nodes in any of the ZooKeeper create modes.
2. Get and Set the data contents of arbitrary cluster nodes (data
being set must be convertible to `byte[]`).
-3. Create and retrieve the list the child nodes attached to a
+3. Create and retrieve the list of the child nodes attached to a
particular node.
Maven users will need to add the following dependency to their `pom.xml`
@@ -79,7 +79,7 @@ the rest of the route:
from("zookeeper://localhost:39913/somepath/somenode").to("mock:result");
----
-If the node does not yet exist then a flag can be supplied to have the
+If the node does not yet exist, then a flag can be supplied to have the
endpoint await its creation:
[source,java]
@@ -116,7 +116,7 @@ not to `/somepath/somenode` but to the path from the header
`/somepath/someothernode`.
WARNING: the `testPayload` must be convertible
-to `byte[]` as the data stored in ZooKeeper is byte based.
+to `byte[]` as the data stored in ZooKeeper is byte-based.
[source,java]
----
@@ -158,10 +158,10 @@ or equivalently:
ZooKeeper nodes can have different types; they can be 'Ephemeral' or
'Persistent' and 'Sequenced' or 'Unsequenced'. For further information
-of each type you can check
+of each type, you can check
http://zookeeper.apache.org/doc/trunk/zookeeperProgrammers.html#Ephemeral+Nodes[here].
-By default endpoints will create unsequenced, ephemeral nodes, but the
-type can be easily manipulated via a uri config parameter or via a
+By default, endpoints will create unsequenced, ephemeral nodes, but the
+type can be easily manipulated via an URI config parameter or via a
special message header. The values expected for the create mode are
simply the names from the `CreateMode` enumeration:
@@ -170,7 +170,7 @@ simply the names from the `CreateMode` enumeration:
* `EPHEMERAL`
* `EPHEMERAL_SEQUENTIAL`
-For example to create a persistent _znode_ via the URI config:
+For example, to create a persistent _znode_ via the URI config:
[source,java]
----
@@ -181,7 +181,7 @@ from("direct:create-and-write-to-persistent-znode")
or using the header `CamelZookeeperCreateMode`.
WARNING: the `testPayload` must be convertible to `byte[]` as the data stored
in
-ZooKeeper is byte based.
+ZooKeeper is byte-based.
[source,java]
----
