[camel-kafka-connector] branch master updated: Added Contributing documentation (beginning)

[ac...@apache.org]

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 44168cc  Added Contributing documentation (beginning)
44168cc is described below

commit 44168cc81485a3c829f046b2557cbf4ac5f1776b
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Wed Apr 22 10:46:18 2020 +0200

    Added Contributing documentation (beginning)
---
 docs/modules/ROOT/nav.adoc                |  1 +
 docs/modules/ROOT/pages/contributing.adoc | 35 +++++++++++++++++++++++++++++++
 docs/modules/ROOT/pages/index.adoc        |  1 +
 3 files changed, 37 insertions(+)

diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index 9d654ba..fb9c166 100644
--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@@ -3,3 +3,4 @@
 ** xref:try-it-out-locally.adoc[Try it locally]
 ** xref:try-it-out-on-openshift-with-strimzi.adoc[Try it on OpenShift cluster]
 ** xref:getting-started-with-packages.adoc[Packages documentation]
+* xref:contributing.adoc[Contributing]
diff --git a/docs/modules/ROOT/pages/contributing.adoc b/docs/modules/ROOT/pages/contributing.adoc
new file mode 100644
index 0000000..ab15dc8
--- /dev/null
+++ b/docs/modules/ROOT/pages/contributing.adoc
@@ -0,0 +1,35 @@
+[[Contributing-Contributing]]
+= Contributing to Camel-Kafka-connector
+
+First of all, thank you for having an interest in contributing to Camel-Kafka-connector.
+
+The Apache Camel community is a great group of contributors and Camel-Kafka-connector is the newer subproject in the ecosystem.
+
+There are multiple areas in which camel-kafka-connector could be improved. Here are some examples:
+
+* Surfing the basic documentation - if something is not clear, let us know or fix it yourself.
+* Try the xref:getting-started.adoc[Getting started] guide
+* Digging in the codebase and tune some operations or add new features.
+* Take a look at the https://github.com/apache/camel-kafka-connector/issues[open issues] and leave a comment on the issue to let us know you are working on it.
+
+[[Contributing-Contents]]
+== Table of Contents
+
+* <<getting-in-touch,Getting in touch>>
+
+[#getting-in-touch]
+== Getting in touch
+
+Apache Camel Kafka Connector is an Apache Software Foundation project.
+
+All communication is subject to the https://www.apache.org/foundation/policies/conduct.html[ASF Code of Conduct].
+
+There are various ways of communicating with the Camel community.
+
+We can also be reached on the Gitter chat at https://gitter.im/apache/camel-kafka-connector/.
+
+We track issues using the https://github.com/apache/camel-kafka-connector/issues[issues tracker in Github]
+
+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.
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
index c98658b..10c14c0 100644
--- a/docs/modules/ROOT/pages/index.adoc
+++ b/docs/modules/ROOT/pages/index.adoc
@@ -6,3 +6,4 @@
 ** xref:try-it-out-locally.adoc[Try it locally]
 ** xref:try-it-out-on-openshift-with-strimzi.adoc[Try it on OpenShift cluster]
 ** xref:getting-started-with-packages.adoc[Packages documentation]
+* xref:contributing.adoc[Contributing]