[camel-karaf] branch master updated: CAMEL-14803: Add Antora documentation

[zr...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zregvart pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-karaf.git


The following commit(s) were added to refs/heads/master by this push:
     new 9661c43  CAMEL-14803: Add Antora documentation
9661c43 is described below

commit 9661c4303d08b1dae4fabdfe5e373060ef0e12f8
Author: Zoran Regvart <zr...@apache.org>
AuthorDate: Fri Mar 27 13:56:16 2020 +0100

    CAMEL-14803: Add Antora documentation
    
    This adds the basic Antora skeleton to the camel-karaf, the index.adoc
    file was taken from the Camel user manual (karaf.adoc).
---
 docs/antora.yml                    |  5 +++
 docs/modules/ROOT/nav.adoc         |  0
 docs/modules/ROOT/pages/index.adoc | 65 ++++++++++++++++++++++++++++++++++++++
 3 files changed, 70 insertions(+)

diff --git a/docs/antora.yml b/docs/antora.yml
new file mode 100644
index 0000000..085868e
--- /dev/null
+++ b/docs/antora.yml
@@ -0,0 +1,5 @@
+name: camel-karaf
+title: Apache Camel Karaf
+version: latest
+nav:
+- modules/ROOT/nav.adoc
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
new file mode 100644
index 0000000..e69de29
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
new file mode 100644
index 0000000..50775fd
--- /dev/null
+++ b/docs/modules/ROOT/pages/index.adoc
@@ -0,0 +1,65 @@
+= Support for Apache Karaf
+
+Apache Camel is designed to work nicely into
+http://karaf.apache.org[Apache Karaf] OSGi container.
+
+It includes:
+
+* Camel features descriptor allowing to easily and quickly install Camel
+in Karaf.
+* Camel Karaf commands allowing you to view, start, stop, get info, about the
+Camel contexts and routes running in the Karaf instance.
+
+
+== Install Camel in Karaf
+
+Assuming that you have a running Karaf instance, you can register the
+Camel features descriptor:
+
+[source,sh]
+----
+karaf@root> features:repo-add camel 2.24.2
+----
+
+where 2.24.2 is the Camel version
+
+Now, we have all Camel features available:
+
+To install Camel, just install the `camel` feature:
+
+[source,sh]
+----
+karaf@root> feature:install camel
+----
+
+You have to install the Camel features depending of your requirements.
+
+If, in your route, you use an endpoint like `stream:out`, you have to
+install the `camel-stream` feature:
+
+[source,sh]
+----
+karaf@root> feature:install camel-stream
+----
+
+And so on, for example if you use the sql, and http components:
+
+[source,sh]
+----
+karaf@root> feature:install camel-sql camel-http
+----
+
+== Camel Karaf commands
+
+When you install the camel feature, new Camel Karaf commands become available
+automatically.
+
+For example to list all running Camel contexts:
+[source,sh]
+----
+karaf@root> karaf@root> camel:context-list
+----
+
+You can see all the Camel commands by typing `camel:` and then pressing TAB key.
+
+TIP: use kbd:[TAB] key for completion on the Camel context name.