You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2020/02/11 10:59:14 UTC

[camel-kafka-connector] branch master updated: feat(docs): setup Antora

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

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


The following commit(s) were added to refs/heads/master by this push:
     new ed107d2  feat(docs): setup Antora
     new bf6431a  Merge pull request #87 from zregvart/pr/antora
ed107d2 is described below

commit ed107d20c03b0bae278712d01440d80ce8c2dca3
Author: Zoran Regvart <zr...@apache.org>
AuthorDate: Tue Feb 11 11:24:16 2020 +0100

    feat(docs): setup Antora
    
    This sets up the Antora directory structure for the documentation and
    adds a simple `index.adoc` as a starting point for the documentation.
---
 docs/antora.yml                                                      | 5 +++++
 docs/modules/ROOT/nav.adoc                                           | 3 +++
 docs/modules/ROOT/pages/index.adoc                                   | 5 +++++
 docs/{ => modules/ROOT/pages}/try-it-out-locally.adoc                | 0
 .../ROOT/pages}/try-it-out-on-openshift-with-strimzi.adoc            | 0
 5 files changed, 13 insertions(+)

diff --git a/docs/antora.yml b/docs/antora.yml
new file mode 100644
index 0000000..dbf29ab
--- /dev/null
+++ b/docs/antora.yml
@@ -0,0 +1,5 @@
+name: camel-kafka-connector
+title: Apache Camel Kafka Connector
+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..d52b439
--- /dev/null
+++ b/docs/modules/ROOT/nav.adoc
@@ -0,0 +1,3 @@
+* xref:index.adoc[About]
+* xref:try-it-out-locally.adoc[Try it out locally]
+* xref:try-it-out-on-openshift-with-strimzi.adoc[Try it out on OpenShift with Strimzi]
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
new file mode 100644
index 0000000..01018b6
--- /dev/null
+++ b/docs/modules/ROOT/pages/index.adoc
@@ -0,0 +1,5 @@
+# About Apache Camel Kafka Connector
+
+Camel Kafka Connector allows you to use all Camel xref:components::index.adoc[components] within the http://kafka.apache.org/documentation/#connect[Kafka Connect].
+
+To get started try it out xref:try-it-out-locally.adoc[locally] or on xref:try-it-out-on-openshift-with-strimzi.adoc[OpenShift cluster] with https://strimzi.io/[Strimzi].
diff --git a/docs/try-it-out-locally.adoc b/docs/modules/ROOT/pages/try-it-out-locally.adoc
similarity index 100%
rename from docs/try-it-out-locally.adoc
rename to docs/modules/ROOT/pages/try-it-out-locally.adoc
diff --git a/docs/try-it-out-on-openshift-with-strimzi.adoc b/docs/modules/ROOT/pages/try-it-out-on-openshift-with-strimzi.adoc
similarity index 100%
rename from docs/try-it-out-on-openshift-with-strimzi.adoc
rename to docs/modules/ROOT/pages/try-it-out-on-openshift-with-strimzi.adoc