camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject camel git commit: Added camel-core docs to Gitbook
Date Sun, 31 Jul 2016 08:53:13 GMT
Repository: camel
Updated Branches:
  refs/heads/master 05b3fce9e -> ffb006008


Added camel-core docs to Gitbook


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/ffb00600
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/ffb00600
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/ffb00600

Branch: refs/heads/master
Commit: ffb006008c9bc87df739e30b79e107013594365a
Parents: 05b3fce
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Sun Jul 31 10:52:47 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Sun Jul 31 10:52:47 2016 +0200

----------------------------------------------------------------------
 docs/user-manual/en/SUMMARY.md                  |   2 +-
 docs/user-manual/en/camel-core.adoc             |  58 +++++++++++++++++++
 .../en/camel-core.data/architecture.png         | Bin 0 -> 7767 bytes
 .../architecture_incl_violations.png            | Bin 0 -> 23733 bytes
 4 files changed, 59 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/ffb00600/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index da15c00..d621211 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -12,6 +12,7 @@
     * [BAM](bam.adoc)
     * [Batch Consumer](batch-consumer.adoc)
     * [BrowsableEndpoint](browsable-endpoint.adoc)
+    * [Camel Core](camel-core.adoc)
     * [CamelContext](camelcontext.adoc)
     * [CEP](cep.adoc)
     * [Debugger](debugger.adoc)
@@ -37,7 +38,6 @@
     * [Scala DSL](scala-dsl.adoc)
 
 <!--
-    * [AOP](aop.adoc)
     * [Camel-Core](camel-core.adoc)
     * [Error Handler](.adoc)
     * [Expression](.adoc)

http://git-wip-us.apache.org/repos/asf/camel/blob/ffb00600/docs/user-manual/en/camel-core.adoc
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/camel-core.adoc b/docs/user-manual/en/camel-core.adoc
new file mode 100644
index 0000000..dcca0c2
--- /dev/null
+++ b/docs/user-manual/en/camel-core.adoc
@@ -0,0 +1,58 @@
+[Tip]
+====
+
+
+This page is work in progress. The layering is probably not yet correct
+
+====
+
+Camel-core is the basic module of apache camel. It contains the public
+API and the Java DSL and several implementation packages.
+
+The most important packages are:
+[width="100%",cols="20%,80%",options="header",]
+|=======================================================================
+|Package Name |Description
+
+|builder |The Camel Domain Specific Language for creating Routes, Predicates,
+Expressions and Error Handlers
+
+|model |Contains the classes (*Type) that form the java DSL. The central class
+is the RouteBuilder
+
+|language |Language APIs and plugins for Expressions and Predicates
+
+|component |Some simple components like bean or log. You will find most components
+in the other camel modules
+
+|impl |Implementation classes for model and camel
+
+|processor |Processors to implement the Enterprise Integration Patterns
+
+|spi |Service provider interfaces. Strategy APIs for implementors to extend
+Camel
+
+|camel |Base package for camel. Defintions like Message and CamelContext can be
+found there
+|=======================================================================
+
+[[Camel-Core-ArchitectureDiagram]]
+Architecture Diagram
+--------------------
+
+The diagram shows the (relaxed) layering of the top level packages in
+camel-core. Relaxed means that a layer may reference any layer below
+it.image:camel-core.data/architecture.png[image]
+
+[[Camel-Core-ArchitectureDiagramincludingcurrentviolations]]
+Architecture Diagram including current violations 
+--------------------------------------------------
+
+Each arrow upwards shows a violation in the layering. That means some
+class inside the package references a class of a package above it. These
+diagrams were built with an architecture tool called structure 101. We
+have an offer from the manufacturer headway software to supply us with
+licenses for all camel developers that are interested. If you want a
+license please contact me (Christian Schneider chris at
+die-schneider.net). I will then try to organize a license for you. +
+ image:camel-core.data/architecture_incl_violations.png[image]

http://git-wip-us.apache.org/repos/asf/camel/blob/ffb00600/docs/user-manual/en/camel-core.data/architecture.png
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/camel-core.data/architecture.png b/docs/user-manual/en/camel-core.data/architecture.png
new file mode 100644
index 0000000..6f5f766
Binary files /dev/null and b/docs/user-manual/en/camel-core.data/architecture.png differ

http://git-wip-us.apache.org/repos/asf/camel/blob/ffb00600/docs/user-manual/en/camel-core.data/architecture_incl_violations.png
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/camel-core.data/architecture_incl_violations.png b/docs/user-manual/en/camel-core.data/architecture_incl_violations.png
new file mode 100644
index 0000000..78865e7
Binary files /dev/null and b/docs/user-manual/en/camel-core.data/architecture_incl_violations.png
differ


Mime
View raw message