You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2021/08/09 11:50:23 UTC

[camel] 04/05: Polish and cleanup documentation

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

davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git

commit ed8dc7f79b6dff5cee5fb505eec3c13e0033cc20
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Mon Aug 9 13:38:02 2021 +0200

    Polish and cleanup documentation
---
 .../modules/ROOT/assets/images/architecture.png    | Bin 7767 -> 0 bytes
 .../assets/images/architecture_incl_violations.png | Bin 23733 -> 0 bytes
 docs/user-manual/modules/ROOT/nav.adoc             |   1 -
 .../user-manual/modules/ROOT/pages/camel-core.adoc |  59 ---------------------
 docs/user-manual/modules/ROOT/pages/index.adoc     |   1 -
 5 files changed, 61 deletions(-)

diff --git a/docs/user-manual/modules/ROOT/assets/images/architecture.png b/docs/user-manual/modules/ROOT/assets/images/architecture.png
deleted file mode 100644
index 6f5f766..0000000
Binary files a/docs/user-manual/modules/ROOT/assets/images/architecture.png and /dev/null differ
diff --git a/docs/user-manual/modules/ROOT/assets/images/architecture_incl_violations.png b/docs/user-manual/modules/ROOT/assets/images/architecture_incl_violations.png
deleted file mode 100644
index 78865e7..0000000
Binary files a/docs/user-manual/modules/ROOT/assets/images/architecture_incl_violations.png and /dev/null differ
diff --git a/docs/user-manual/modules/ROOT/nav.adoc b/docs/user-manual/modules/ROOT/nav.adoc
index 299674c..69d55f4 100644
--- a/docs/user-manual/modules/ROOT/nav.adoc
+++ b/docs/user-manual/modules/ROOT/nav.adoc
@@ -41,7 +41,6 @@
 ** xref:bean-binding.adoc[Bean Binding]
 ** xref:bean-integration.adoc[Bean Integration]
 ** xref:browsable-endpoint.adoc[BrowsableEndpoint]
-** xref:camel-core.adoc[Core]
 ** xref:camelcontext.adoc[Context]
 ** xref:clustering.adoc[Clustering and loadbalancing]
 ** xref:cep.adoc[Complex Event Processing]
diff --git a/docs/user-manual/modules/ROOT/pages/camel-core.adoc b/docs/user-manual/modules/ROOT/pages/camel-core.adoc
deleted file mode 100644
index 0c8c4d0..0000000
--- a/docs/user-manual/modules/ROOT/pages/camel-core.adoc
+++ /dev/null
@@ -1,59 +0,0 @@
-= Camel Core
-
-[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. Definitions 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::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::architecture_incl_violations.png[image]
diff --git a/docs/user-manual/modules/ROOT/pages/index.adoc b/docs/user-manual/modules/ROOT/pages/index.adoc
index 941d466..ff05edf 100644
--- a/docs/user-manual/modules/ROOT/pages/index.adoc
+++ b/docs/user-manual/modules/ROOT/pages/index.adoc
@@ -81,7 +81,6 @@ camel routes without them knowing
 * xref:batch-consumer.adoc[Batch Consumer]
 * xref:browsable-endpoint.adoc[BrowsableEndpoint]
 * xref:camelcontext.adoc[CamelContext]
-* xref:camel-core.adoc[Camel Core]
 * xref:cep.adoc[CEP]
 * xref:clustering.adoc[Clustering and loadbalancing]
 * xref:components::index.adoc[Component]