This is an automated email from the ASF dual-hosted git repository.
jamesnetherton pushed a commit to branch 3.15.x
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
The following commit(s) were added to refs/heads/3.15.x by this push:
new 47ceec19f9 Add a brief explanation of yaml-io usage to the extension
documentation
47ceec19f9 is described below
commit 47ceec19f90087ab76a2a9969976379b98e3e2e9
Author: James Netherton <[email protected]>
AuthorDate: Tue Oct 22 13:47:30 2024 +0100
Add a brief explanation of yaml-io usage to the extension documentation
---
docs/modules/ROOT/pages/reference/extensions/yaml-io.adoc | 12 ++++++++++++
extensions-core/yaml-io/runtime/src/main/doc/usage.adoc | 8 ++++++++
2 files changed, 20 insertions(+)
diff --git a/docs/modules/ROOT/pages/reference/extensions/yaml-io.adoc
b/docs/modules/ROOT/pages/reference/extensions/yaml-io.adoc
index a79cf59de1..a98240b566 100644
--- a/docs/modules/ROOT/pages/reference/extensions/yaml-io.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/yaml-io.adoc
@@ -36,3 +36,15 @@ Or add the coordinates to your existing project:
ifeval::[{doc-show-user-guide-link} == true]
Check the xref:user-guide/index.adoc[User guide] for more information about
writing Camel Quarkus applications.
endif::[]
+
+[id="extensions-yaml-io-usage"]
+== Usage
+This an auxiliary extension that provides support for Camel route dumping in
YAML.
+
+For example, when the application is configured to dump routes on startup with
the following configuration in `application.properties`.
+
+[source,properties]
+----
+camel.main.dump-routes = yaml
+----
+
diff --git a/extensions-core/yaml-io/runtime/src/main/doc/usage.adoc
b/extensions-core/yaml-io/runtime/src/main/doc/usage.adoc
new file mode 100644
index 0000000000..fe8abfa498
--- /dev/null
+++ b/extensions-core/yaml-io/runtime/src/main/doc/usage.adoc
@@ -0,0 +1,8 @@
+This an auxiliary extension that provides support for Camel route dumping in
YAML.
+
+For example, when the application is configured to dump routes on startup with
the following configuration in `application.properties`.
+
+[source,properties]
+----
+camel.main.dump-routes = yaml
+----
