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 de7afc7cead9759e35891664db8847b1d92a3a4c
Author: Otavio R. Piske <angusyo...@gmail.com>
AuthorDate: Sat Feb 17 13:33:15 2024 +0100
CAMEL-20410: documentation fixes for camel-cron
- Fixed samples
- Converted to use tabs
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <angusyo...@gmail.com>
---
.../camel-cron/src/main/docs/cron-component.adoc | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/components/camel-cron/src/main/docs/cron-component.adoc
b/components/camel-cron/src/main/docs/cron-component.adoc
index d946f209380..c5e4e32a8e7 100644
--- a/components/camel-cron/src/main/docs/cron-component.adoc
+++ b/components/camel-cron/src/main/docs/cron-component.adoc
@@ -14,16 +14,16 @@
*{component-header}*
-The Cron component is a generic interface component that allows triggering
events at specific time interval
+The Cron component is a generic interface component that allows triggering
events at a specific time interval
specified using the Unix cron syntax (e.g. `0/2 * * * * ?` to trigger an event
every two seconds).
-Being an interface component, the Cron component does not contain a default
implementation, instead it requires that the users plug
-the implementation of their choice.
+As an interface component, the Cron component does not contain a default
implementation.
+Instead, it requires that the users plug the implementation of their choice.
The following standard Camel components support the Cron endpoints:
-- Camel-quartz
-- Camel-spring
+- xref:components::quartz-component.adoc[Camel Quartz]
+- xref:components::spring-summary.adoc[Camel Spring]
The Cron component is also supported in **Camel K**, which can use the
Kubernetes scheduler to trigger the routes when required by the cron expression.
Camel K does not require additional libraries to be plugged when using cron
expressions compatible with Kubernetes cron syntax.
@@ -41,7 +41,7 @@ for this component:
</dependency>
------------------------------------------------------------
-Additional libraries may be needed in order to plug a specific implementation.
+Additional libraries may be needed to plug a specific implementation.
// component-configure options: START
@@ -70,22 +70,22 @@ from("cron:tab?schedule=0/1+*+*+*+*+?")
The schedule expression `0/3{plus}10{plus}*{plus}*{plus}*{plus}?` can be also
written as `0/3 10 * * * ?` and triggers an event every three seconds only in
the tenth minute of each hour.
-Parts in the schedule expression means (in order):
+Breaking down the parts in the schedule expression(in order):
- Seconds (optional)
- Minutes
- Hours
- Day of month
- Month
-- Day of week
+- Day of the week
- Year (optional)
-Schedule expressions can be made of 5 to 7 parts. When expressions are
composed of 6 parts, the first items is the "seconds" part (and year is
considered missing).
+Schedule expressions can be made of five to seven parts. When expressions are
composed of six parts, the first items is the _Seconds_ part (and year is
considered missing).
Other valid examples of schedule expressions are:
-- `0/2 * * * ?` (5 parts, an event every two minutes)
-- `0 0/2 * * * MON-FRI 2030` (7 parts, an event every two minutes only in year
2030)
+- `0/2 * * * ?` (Five parts, an event every two minutes)
+- `0 0/2 * * * MON-FRI 2030` (Seven parts, an event every two minutes only in
the year 2030)
Routes can also be written using the XML DSL.
