[camel-kafka-connector] branch docs-up created (now 6830e2f)

[ac...@apache.org]

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

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


      at 6830e2f  Added a building section in the docs

This branch includes the following new commits:

     new 6830e2f  Added a building section in the docs

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.

[camel-kafka-connector] 01/01: Added a building section in the docs

[ac...@apache.org]

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

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

commit 6830e2f883981e31b90ede95b64ff427e1098118
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Tue Apr 28 15:14:43 2020 +0200

    Added a building section in the docs
---
 docs/modules/ROOT/pages/contributing.adoc | 65 +++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)

diff --git a/docs/modules/ROOT/pages/contributing.adoc b/docs/modules/ROOT/pages/contributing.adoc
index ab15dc8..769bc2c 100644
--- a/docs/modules/ROOT/pages/contributing.adoc
+++ b/docs/modules/ROOT/pages/contributing.adoc
@@ -16,6 +16,7 @@ There are multiple areas in which camel-kafka-connector could be improved. Here
 == Table of Contents
 
 * <<getting-in-touch,Getting in touch>>
+* <<building-the-project,Building the project>>
 
 [#getting-in-touch]
 == Getting in touch
@@ -33,3 +34,67 @@ We track issues using the https://github.com/apache/camel-kafka-connector/issues
 When you're ready to contribute create a Pull request to the https://github.com/apache/camel-kafka-connector/[camel-kafka-connector repository]
 
 Expect that your Pull request will receive a review and that you will need to respond and correspond to that via comments at GitHub.
+
+[#building-the-project]
+== Building the project
+
+Basically you could run
+
+[source,bash]
+----
+mvn clean package
+----
+
+=== Build the project and run integration tests
+
+To build the project it is sufficient to:
+
+[source,bash]
+----
+mvn clean install
+----
+To run the integration tests it is required to:
+
+  * have Docker version 17.05 or higher running
+  * run:
+
+[source,bash]
+----
+mvn -DskipIntegrationTests=false clean verify package
+----
+
+It is also possible to point the tests to use an external services. To do so, you must set
+properties for the services that you want to run. This causes the tests to not launch the local
+container and use existing remote instances. At the moment, the following properties can be set
+for remote testing:
+
+* kafka.instance.type
+** kafka.bootstrap.servers
+* aws-service.instance.type
+** access.key: AWS access key (mandatory for remote testing)
+** secret.key: AWS secret key (mandatory for remote testing)
+** aws.region: AWS region (optional)
+** aws.host: AWS host (optional)
+* aws-service.kinesis.instance.type
+** access.key: AWS access key (mandatory for remote testing)
+** secret.key: AWS secret key (mandatory for remote testing)
+** aws.region: AWS region (optional)
+** aws.host: AWS host (optional)
+* elasticsearch.instance.type
+** elasticsearch.host
+** elasticsearch.port
+* cassandra.instance.type
+** cassandra.host
+** cassandra.cql3.port
+* jms-service.instance.type
+** jms.broker.address
+
+For example you can run
+
+----
+mvn -Dkafka.bootstrap.servers=host1:port -Dkafka.instance.type=remote -DskipIntegrationTests=false clean verify package
+----
+
+It's possible to use a properties file to set these properties. To do so use `-Dtest.properties=/path/to/file.properties`.
+
+