This is an automated email from the ASF dual-hosted git repository.
ppalaga pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-quarkus-examples.git
The following commit(s) were added to refs/heads/master by this push:
new 33a54f0 Structure the READMEs, generate adoc pages to be able to
generate the table in the Camel Quarkus docs
33a54f0 is described below
commit 33a54f0fb728baccc2103ef45247a432b018b074
Author: Peter Palaga <[email protected]>
AuthorDate: Fri Oct 2 16:59:25 2020 +0200
Structure the READMEs, generate adoc pages to be able to generate the
table in the Camel Quarkus docs
---
docs/antora.yml | 20 +++++++++++
docs/modules/ROOT/pages/file-split-log-xml.adoc | 4 +++
docs/modules/ROOT/pages/health.adoc | 4 +++
docs/modules/ROOT/pages/http-log.adoc | 4 +++
docs/modules/ROOT/pages/observability.adoc | 4 +++
docs/modules/ROOT/pages/rest-json.adoc | 4 +++
docs/modules/ROOT/pages/timer-log-cdi.adoc | 4 +++
docs/modules/ROOT/pages/timer-log-kotlin.adoc | 4 +++
docs/modules/ROOT/pages/timer-log-main.adoc | 4 +++
docs/modules/ROOT/pages/timer-log-spring.adoc | 4 +++
docs/modules/ROOT/pages/timer-log-xml.adoc | 4 +++
docs/modules/ROOT/pages/timer-log.adoc | 4 +++
file-split-log-xml/README.adoc | 18 +++++-----
health/README.adoc | 10 +++---
http-log/README.adoc | 7 ++--
.../main/java/org/acme/http/ExampleResource.java | 8 +++++
mvnw-for-each.sh | 3 ++
observability/README.adoc | 5 +--
rest-json/README.adoc | 5 ++-
timer-log-cdi/README.adoc | 7 ++--
{timer-log-main => timer-log-kotlin}/README.adoc | 6 ++--
timer-log-main/README.adoc | 33 ++++++++++++-----
.../src/main/java/org/acme/timer/Main.java | 41 +++++++++++++++++++++-
.../src/main/java/org/acme/timer/TimerRoute.java | 8 ++++-
timer-log-spring/README.adoc | 7 ++--
timer-log-xml/README.adoc | 7 ++--
timer-log/README.adoc | 6 ++--
27 files changed, 187 insertions(+), 48 deletions(-)
diff --git a/docs/antora.yml b/docs/antora.yml
new file mode 100644
index 0000000..a94ef5a
--- /dev/null
+++ b/docs/antora.yml
@@ -0,0 +1,20 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+name: camel-quarkus-examples
+title: Camel Quarkus examples
+version: latest
diff --git a/docs/modules/ROOT/pages/file-split-log-xml.adoc
b/docs/modules/ROOT/pages/file-split-log-xml.adoc
new file mode 100644
index 0000000..de588d4
--- /dev/null
+++ b/docs/modules/ROOT/pages/file-split-log-xml.adoc
@@ -0,0 +1,4 @@
+= Tokenize a CSV file: A Camel Quarkus example
+:cq-example-title: Tokenize a CSV file
+:cq-example-description: Shows how to define a Camel route in XML for
tokenizing a CSV a file.
+:cq-example-url:
https://github.com/apache/camel-quarkus-examples/tree/master/file-split-log-xml
diff --git a/docs/modules/ROOT/pages/health.adoc
b/docs/modules/ROOT/pages/health.adoc
new file mode 100644
index 0000000..140eaee
--- /dev/null
+++ b/docs/modules/ROOT/pages/health.adoc
@@ -0,0 +1,4 @@
+= Health: A Camel Quarkus example
+:cq-example-title: Health
+:cq-example-description: Shows how to use Camel health-checks with Quarkus.
+:cq-example-url:
https://github.com/apache/camel-quarkus-examples/tree/master/health
diff --git a/docs/modules/ROOT/pages/http-log.adoc
b/docs/modules/ROOT/pages/http-log.adoc
new file mode 100644
index 0000000..e1d21c1
--- /dev/null
+++ b/docs/modules/ROOT/pages/http-log.adoc
@@ -0,0 +1,4 @@
+= HTTP with vanilla JAX-RS or with Camel `platform-http` component: A Camel
Quarkus example
+:cq-example-title: HTTP with vanilla JAX-RS or with Camel `platform-http`
component
+:cq-example-description: Shows how to create HTTP endpoints using either the
RESTEasy
+:cq-example-url:
https://github.com/apache/camel-quarkus-examples/tree/master/http-log
diff --git a/docs/modules/ROOT/pages/observability.adoc
b/docs/modules/ROOT/pages/observability.adoc
new file mode 100644
index 0000000..67f1e9b
--- /dev/null
+++ b/docs/modules/ROOT/pages/observability.adoc
@@ -0,0 +1,4 @@
+= Observability: A Camel Quarkus example
+:cq-example-title: Observability
+:cq-example-description: Demonstrates how to add support for metrics, health
checks and distributed tracing
+:cq-example-url:
https://github.com/apache/camel-quarkus-examples/tree/master/observability
diff --git a/docs/modules/ROOT/pages/rest-json.adoc
b/docs/modules/ROOT/pages/rest-json.adoc
new file mode 100644
index 0000000..8ee37f0
--- /dev/null
+++ b/docs/modules/ROOT/pages/rest-json.adoc
@@ -0,0 +1,4 @@
+= REST with `platform-http`: A Camel Quarkus example
+:cq-example-title: REST with `platform-http`
+:cq-example-description: Demonstrates how to create a REST service using
`platform-http` Camel component and Jackson.
+:cq-example-url:
https://github.com/apache/camel-quarkus-examples/tree/master/rest-json
diff --git a/docs/modules/ROOT/pages/timer-log-cdi.adoc
b/docs/modules/ROOT/pages/timer-log-cdi.adoc
new file mode 100644
index 0000000..5a81d05
--- /dev/null
+++ b/docs/modules/ROOT/pages/timer-log-cdi.adoc
@@ -0,0 +1,4 @@
+= Configure a Camel component using CDI: A Camel Quarkus example
+:cq-example-title: Configure a Camel component using CDI
+:cq-example-description: Demonstrates how to set-up a Camel component (the
`log` component in this case) programmatically using CDI
+:cq-example-url:
https://github.com/apache/camel-quarkus-examples/tree/master/timer-log-cdi
diff --git a/docs/modules/ROOT/pages/timer-log-kotlin.adoc
b/docs/modules/ROOT/pages/timer-log-kotlin.adoc
new file mode 100644
index 0000000..2708bc8
--- /dev/null
+++ b/docs/modules/ROOT/pages/timer-log-kotlin.adoc
@@ -0,0 +1,4 @@
+= Kotlin Hello World: A Camel Quarkus example
+:cq-example-title: Kotlin Hello World
+:cq-example-description: Shows how to define Camel routes using Kotlin
programming language
+:cq-example-url:
https://github.com/apache/camel-quarkus-examples/tree/master/timer-log-kotlin
diff --git a/docs/modules/ROOT/pages/timer-log-main.adoc
b/docs/modules/ROOT/pages/timer-log-main.adoc
new file mode 100644
index 0000000..4861d1a
--- /dev/null
+++ b/docs/modules/ROOT/pages/timer-log-main.adoc
@@ -0,0 +1,4 @@
+= Custom `main()`: A Camel Quarkus example
+:cq-example-title: Custom `main()`
+:cq-example-description: Shows how to start Camel from a custom `main()` method
+:cq-example-url:
https://github.com/apache/camel-quarkus-examples/tree/master/timer-log-main
diff --git a/docs/modules/ROOT/pages/timer-log-spring.adoc
b/docs/modules/ROOT/pages/timer-log-spring.adoc
new file mode 100644
index 0000000..c2fd09d
--- /dev/null
+++ b/docs/modules/ROOT/pages/timer-log-spring.adoc
@@ -0,0 +1,4 @@
+= Spring Dependency Injection: A Camel Quarkus example
+:cq-example-title: Spring Dependency Injection
+:cq-example-description: Shows how to use Spring Dependency Injection when
defining routes on Camel Quarkus.
+:cq-example-url:
https://github.com/apache/camel-quarkus-examples/tree/master/timer-log-spring
diff --git a/docs/modules/ROOT/pages/timer-log-xml.adoc
b/docs/modules/ROOT/pages/timer-log-xml.adoc
new file mode 100644
index 0000000..8d62e99
--- /dev/null
+++ b/docs/modules/ROOT/pages/timer-log-xml.adoc
@@ -0,0 +1,4 @@
+= XML Hello World: A Camel Quarkus example
+:cq-example-title: XML Hello World
+:cq-example-description: Shows how to define Camel routes using XML.
+:cq-example-url:
https://github.com/apache/camel-quarkus-examples/tree/master/timer-log-xml
diff --git a/docs/modules/ROOT/pages/timer-log.adoc
b/docs/modules/ROOT/pages/timer-log.adoc
new file mode 100644
index 0000000..1034e9d
--- /dev/null
+++ b/docs/modules/ROOT/pages/timer-log.adoc
@@ -0,0 +1,4 @@
+= Timer Hello World: A Camel Quarkus example
+:cq-example-title: Timer Hello World
+:cq-example-description: An example using the Camel timer component to output
a Hello world message to the console
+:cq-example-url:
https://github.com/apache/camel-quarkus-examples/tree/master/timer-log
diff --git a/file-split-log-xml/README.adoc b/file-split-log-xml/README.adoc
index fa499de..b6a495b 100644
--- a/file-split-log-xml/README.adoc
+++ b/file-split-log-xml/README.adoc
@@ -1,13 +1,15 @@
-= file-split-log-xml
+= Tokenize a CSV file: A Camel Quarkus example
+:cq-example-description: An example that shows how to define a Camel route in
XML for tokenizing a CSV a file.
-This is a basic hello world example that uses XML to set-up a Camel file
consumer which reads a file in the resources folder.
+{cq-description}
-It demonstrates the following;
-1. Reading a file using camel file endpoint as a consumer.
-2. Splitting the file by row.
-3. Splitting the row by columns.
-4. Usage of properties in the camel endpoint uri.
-5. No Java code required or used, the XML can still be compiled to native
code. Pretty cool.
+In particular, it demonstrates the following:
+
+1. Reading a file using Camel `file` component as a consumer
+2. Splitting the file into rows
+3. Splitting the rows into columns
+4. Usage of properties defined in `application.properties` in a Camel endpoint
URI
+5. No Java code required or used, the route defined in XML can still be
compiled to native code.
The file consumer has been marked as non-idempotent thus it will read the same
file again using a configurable 30 second delay.
diff --git a/health/README.adoc b/health/README.adoc
index d61bc6b..c510e64 100644
--- a/health/README.adoc
+++ b/health/README.adoc
@@ -1,14 +1,14 @@
-== Camel Quarkus Example Health
+= Health: A Camel Quarkus example
+:cq-example-description: An example that shows how to use Camel health-checks
with Quarkus.
-This example shows how to use Camel health-check with Quarkus.
-The example shows how you can build custom health-checks and have
-them automatic discovered by Camel and used as parts of its health-check
system.
+{cq-description} It also shows how you can build custom health-checks and have
them automatic discovered by Camel and
+used as parts of its health-check system.
TIP: Check the
https://camel.apache.org/camel-quarkus/latest/first-steps.html[Camel Quarkus
User guide] for prerequisites
and other general information.
The example has two routes. The timer route performs a given task at regular
interval. For the sake of this example we'll say
-that this task unexpectedly freezes the service from time to time. The details
can be consulted at http://localhost:8080/health.
+that this task unexpectedly freezes the service from time to time. The details
can be consulted at http://localhost:8080/health.
The custom health check is expected to report UNKNOWN on first consultation,
then UP during 10 seconds, and finally DOWN so as to
simulate that the service is frozen.
diff --git a/http-log/README.adoc b/http-log/README.adoc
index 15baf95..5306bef 100644
--- a/http-log/README.adoc
+++ b/http-log/README.adoc
@@ -1,7 +1,8 @@
-= http-log
+= HTTP with vanilla JAX-RS or with Camel `platform-http` component: A Camel
Quarkus example
+:cq-example-description: An example that shows how to create HTTP endpoints
using either the RESTEasy
+implementation of JAX-RS or using Camel `platform-http` component.
-This is a basic hello world example that uses CDI and JAX-RS to setup
-a Quarkus REST service and a Camel route to service HTTP traffic.
+{cq-description}
The Quarkus REST service `ExampleResource.java` and the Camel route
`CamelRoute.java`
are independent and are present in this example to demonstrate how you can
build microservices
diff --git a/http-log/src/main/java/org/acme/http/ExampleResource.java
b/http-log/src/main/java/org/acme/http/ExampleResource.java
index 4d71ac1..1db4c3e 100644
--- a/http-log/src/main/java/org/acme/http/ExampleResource.java
+++ b/http-log/src/main/java/org/acme/http/ExampleResource.java
@@ -21,9 +21,17 @@ import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
+/**
+ * A JAX-RS resource
+ */
@Path("/hello")
public class ExampleResource {
+ /**
+ * A JAX-RS endpoint always returning {@code "hello"}
+ *
+ * @return {@code "hello"}
+ */
@GET
@Produces(MediaType.TEXT_PLAIN)
public String hello() {
diff --git a/mvnw-for-each.sh b/mvnw-for-each.sh
index 7f003aa..3f59104 100755
--- a/mvnw-for-each.sh
+++ b/mvnw-for-each.sh
@@ -13,3 +13,6 @@ do
../mvnw "$@"
fi
done
+
+cd "${pwd}"
+./mvnw org.l2x6.cq:cq-maven-plugin:0.23.1:update-example-pages
diff --git a/observability/README.adoc b/observability/README.adoc
index d3ef123..bac5264 100644
--- a/observability/README.adoc
+++ b/observability/README.adoc
@@ -1,6 +1,7 @@
-= Camel Quarkus Observability
+= Observability: A Camel Quarkus example
+:cq-example-description: An example that demonstrates how to add support for
metrics, health checks and distributed tracing
-This example project demonstrates how to add support for metrics, health
checks and distributed tracing.
+{cq-description}
TIP: Check the
https://camel.apache.org/camel-quarkus/latest/first-steps.html[Camel Quarkus
User guide] for prerequisites
and other general information.
diff --git a/rest-json/README.adoc b/rest-json/README.adoc
index be10e2b..f059e21 100644
--- a/rest-json/README.adoc
+++ b/rest-json/README.adoc
@@ -1,4 +1,7 @@
-= rest-json
+= REST with `platform-http`: A Camel Quarkus example
+:cq-example-description: An example that demonstrates how to create a REST
service using `platform-http` Camel component and Jackson.
+
+{cq-description}
This example is a port of Quarkus' quickstart
https://github.com/quarkusio/quarkus-quickstarts/blob/master/rest-json[rest-json]
to Camel.
diff --git a/timer-log-cdi/README.adoc b/timer-log-cdi/README.adoc
index f9d0495..77f6cca 100644
--- a/timer-log-cdi/README.adoc
+++ b/timer-log-cdi/README.adoc
@@ -1,8 +1,7 @@
-= timer-log-cdi
+= Configure a Camel component using CDI: A Camel Quarkus example
+:cq-example-description: An example that demonstrates how to set-up a Camel
component (the `log` component in this case) programmatically using CDI
-This is a basic hello world example that uses CDI to set-up
-a Camel timer that triggers every second and prints to the
-log.
+{cq-description}
TIP: Check the
https://camel.apache.org/camel-quarkus/latest/first-steps.html[Camel Quarkus
User guide] for prerequisites
and other general information.
diff --git a/timer-log-main/README.adoc b/timer-log-kotlin/README.adoc
similarity index 91%
copy from timer-log-main/README.adoc
copy to timer-log-kotlin/README.adoc
index d0497e3..c6cc39b 100644
--- a/timer-log-main/README.adoc
+++ b/timer-log-kotlin/README.adoc
@@ -1,7 +1,7 @@
-= timer-log-main
+= Kotlin Hello World: A Camel Quarkus example
+:cq-example-description: An example that shows how to define Camel routes
using Kotlin programming language
-This is a basic hello world example that uses a custom main to set-up
-a Camel timer that triggers every second and prints to the log.
+{cq-description}
TIP: Check the
https://camel.apache.org/camel-quarkus/latest/first-steps.html[Camel Quarkus
User guide] for prerequisites
and other general information.
diff --git a/timer-log-main/README.adoc b/timer-log-main/README.adoc
index d0497e3..1f538a1 100644
--- a/timer-log-main/README.adoc
+++ b/timer-log-main/README.adoc
@@ -1,16 +1,26 @@
-= timer-log-main
+= Custom `main()`: A Camel Quarkus example
+:cq-example-description: An example that shows how to start Camel from a
custom `main()` method
-This is a basic hello world example that uses a custom main to set-up
-a Camel timer that triggers every second and prints to the log.
+{cq-description}
+
+A custom `main()` method may be useful if you need to implement some custom
logic that needs to be executed before
+starting the Camel context. In this example we do some processing of the
command line parameters.
+
+TIP: IDEs typically allow for starting `main()` methods directly from an open
editor. This may come in handy when
+developing.
TIP: Check the
https://camel.apache.org/camel-quarkus/latest/first-steps.html[Camel Quarkus
User guide] for prerequisites
and other general information.
== Start in the Development mode
+The `main()` method implemented in the `org.acme.timer.Main` requires two
arguments: a greeting and a number how
+many times should the greeting be printed in the log. So we need to pass these
two via `-Dquarkus.args` so that the
+dev mode does not start with an error:
+
[source,shell]
----
-$ mvn clean compile quarkus:dev
+$ mvn clean compile quarkus:dev -Dquarkus.args='Hello 2'
----
The above command compiles the project, starts the application and lets the
Quarkus tooling watch for changes in your
@@ -20,7 +30,9 @@ TIP: Please refer to the Development mode section of
https://camel.apache.org/camel-quarkus/latest/first-steps.html#_development_mode[Camel
Quarkus User guide] for more details.
Then look at the log output in the console. As we run the example in Quarkus
Dev Mode, you can edit the source code and have live updates.
-For example try to change `Incremented the counter` to `Counter state` in the
message body or change the property `timer.period` in application.properties
+For example try to change `greeting = args[i++];` to `greeting = args[i++] +
"!!!";` in the `main()`
+method and you should see the application being recompiled, restarted and the
greeting with three exclamation marks
+should appear in the console.
=== Package and run the application
@@ -34,9 +46,11 @@
https://camel.apache.org/camel-quarkus/latest/first-steps.html#_package_and_run_
[source,shell]
----
$ mvn clean package
-$ java -jar target/*-runner.jar
+$ java -jar target/*-runner.jar Hello 2
+...
+[example] (Camel (camel-6) thread #8 - timer://foo) Exchange[Body: Hello]
+[example] (Camel (camel-6) thread #8 - timer://foo) Exchange[Body: Hello]
...
-[io.quarkus] (main) camel-quarkus-examples-... started in 1.163s.
----
==== Native mode
@@ -49,8 +63,9 @@ To prepare a native executable using GraalVM, run the
following command:
[source,shell]
----
$ mvn clean package -Pnative
-$ ./target/*-runner
+$ ./target/*-runner Hello 2
...
-[io.quarkus] (main) camel-quarkus-examples-... started in 0.013s.
+[example] (Camel (camel-6) thread #8 - timer://foo) Exchange[Body: Hello]
+[example] (Camel (camel-6) thread #8 - timer://foo) Exchange[Body: Hello]
...
----
diff --git a/timer-log-main/src/main/java/org/acme/timer/Main.java
b/timer-log-main/src/main/java/org/acme/timer/Main.java
index 9299d43..575f326 100644
--- a/timer-log-main/src/main/java/org/acme/timer/Main.java
+++ b/timer-log-main/src/main/java/org/acme/timer/Main.java
@@ -16,13 +16,52 @@
*/
package org.acme.timer;
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.inject.Produces;
+import javax.inject.Named;
+
import io.quarkus.runtime.Quarkus;
import io.quarkus.runtime.annotations.QuarkusMain;
import org.apache.camel.quarkus.main.CamelMainApplication;
@QuarkusMain
public class Main {
+
+ private static String greeting;
+
public static void main(String... args) {
- Quarkus.run(CamelMainApplication.class, args);
+
+ /* Any custom logic can be implemented here
+ * Here, we pass the value of the first argument to Quarkus CDI
container so that it can be injected using
+ * @Inject @Named("greeting")
+ * And we pass the second argument as -durationMaxMessages which is
the number of messages that the application
+ * will process before terminating */
+ if (args.length < 2) {
+ throw new IllegalStateException("Expected at least two CLI
arguments");
+ }
+ int i = 0;
+ List<String> filteredArgs = new ArrayList<>(args.length);
+ greeting = args[i++];
+ final String repeatTimes = args[i++];
+ filteredArgs.add("-durationMaxMessages");
+ filteredArgs.add(repeatTimes);
+
+ for (; i < args.length; i++) {
+ filteredArgs.add(args[i++]);
+ }
+
+ Quarkus.run(CamelMainApplication.class, filteredArgs.toArray(new
String[filteredArgs.size()]));
+ }
+
+ @ApplicationScoped
+ public static class GreetingProducer {
+ @Produces
+ @Named("greeting")
+ public String greeting() {
+ return greeting;
+ }
}
}
diff --git a/timer-log-main/src/main/java/org/acme/timer/TimerRoute.java
b/timer-log-main/src/main/java/org/acme/timer/TimerRoute.java
index c33c153..c34d441 100644
--- a/timer-log-main/src/main/java/org/acme/timer/TimerRoute.java
+++ b/timer-log-main/src/main/java/org/acme/timer/TimerRoute.java
@@ -17,6 +17,8 @@
package org.acme.timer;
import javax.enterprise.context.ApplicationScoped;
+import javax.inject.Inject;
+import javax.inject.Named;
import org.apache.camel.builder.RouteBuilder;
@@ -25,10 +27,14 @@ import org.apache.camel.builder.RouteBuilder;
*/
@ApplicationScoped
public class TimerRoute extends RouteBuilder {
+ @Inject
+ @Named("greeting")
+ String greeting;
+
@Override
public void configure() throws Exception {
from("timer:foo?period={{timer.period}}")
- .setBody().constant("Hello from Main!")
+ .setBody().constant(greeting)
.to("log:example");
}
}
diff --git a/timer-log-spring/README.adoc b/timer-log-spring/README.adoc
index 1f65a37..36ef26c 100644
--- a/timer-log-spring/README.adoc
+++ b/timer-log-spring/README.adoc
@@ -1,8 +1,7 @@
-= timer-log-spring
+= Spring Dependency Injection: A Camel Quarkus example
+:cq-example-description: An example that shows how to use Spring Dependency
Injection when defining routes on Camel Quarkus.
-This is a basic hello world example that uses Spring to set-up
-a Camel timer that triggers every second and prints to the
-log.
+{cq-description}
TIP: Check the
https://camel.apache.org/camel-quarkus/latest/first-steps.html[Camel Quarkus
User guide] for prerequisites
and other general information.
diff --git a/timer-log-xml/README.adoc b/timer-log-xml/README.adoc
index 0e7af51..71c4ce5 100644
--- a/timer-log-xml/README.adoc
+++ b/timer-log-xml/README.adoc
@@ -1,8 +1,7 @@
-= timer-log-xml
+= XML Hello World: A Camel Quarkus example
+:cq-example-description: An example that shows how to define Camel routes
using XML.
-This is a basic hello world example that uses XML to set-up
-a Camel timer that triggers every second and prints to the
-log.
+{cq-description}
TIP: Check the
https://camel.apache.org/camel-quarkus/latest/first-steps.html[Camel Quarkus
User guide] for prerequisites
and other general information.
diff --git a/timer-log/README.adoc b/timer-log/README.adoc
index 8596a9f..a4e8a9a 100644
--- a/timer-log/README.adoc
+++ b/timer-log/README.adoc
@@ -1,7 +1,7 @@
-= timer-log
+= Timer Hello World: A Camel Quarkus example
+:cq-example-description: An example using the Camel timer component to output
a Hello world message to the console
-This is a basic hello world example that uses a Camel timer that
-triggers every second and prints to the log.
+{cq-description}
TIP: Check the
https://camel.apache.org/camel-quarkus/latest/first-steps.html[Camel Quarkus
User guide] for prerequisites
and other general information.
