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/19 12:10:35 UTC
[camel] 01/08: 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 3d15cdc4f8639baba78843e6fc0b7290854bc02f
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Thu Aug 19 09:42:30 2021 +0200
Polish and cleanup documentation
---
docs/user-manual/modules/ROOT/nav.adoc | 1 -
.../user-manual/modules/ROOT/pages/clustering.adoc | 3 --
docs/user-manual/modules/ROOT/pages/dsl.adoc | 2 -
.../modules/ROOT/pages/health-check.adoc | 5 +-
docs/user-manual/modules/ROOT/pages/index.adoc | 2 -
docs/user-manual/modules/ROOT/pages/testing.adoc | 16 ------
.../pages/using-osgi-blueprint-with-camel.adoc | 60 ----------------------
.../modules/faq/pages/what-is-camel.adoc | 3 +-
8 files changed, 4 insertions(+), 88 deletions(-)
diff --git a/docs/user-manual/modules/ROOT/nav.adoc b/docs/user-manual/modules/ROOT/nav.adoc
index af8468f..ff93f60 100644
--- a/docs/user-manual/modules/ROOT/nav.adoc
+++ b/docs/user-manual/modules/ROOT/nav.adoc
@@ -16,7 +16,6 @@
** xref:examples.adoc[Examples]
** xref:graceful-shutdown.adoc[Graceful Shutdown]
** xref:error-handler.adoc[Error handler]
-** xref:using-osgi-blueprint-with-camel.adoc[Using OSGi blueprint with Camel]
** xref:using-propertyplaceholder.adoc[How to use Camel property placeholders]
** xref:testing.adoc[Testing]
** xref:rest-dsl.adoc[Working with REST and Rest DSL]
diff --git a/docs/user-manual/modules/ROOT/pages/clustering.adoc b/docs/user-manual/modules/ROOT/pages/clustering.adoc
index dfebc96..5f60e0f 100644
--- a/docs/user-manual/modules/ROOT/pages/clustering.adoc
+++ b/docs/user-manual/modules/ROOT/pages/clustering.adoc
@@ -46,8 +46,6 @@ Out of the box camel provides the following implementations:
|zookeeper |camel-zookeeper | org.apache.camel.component.zookeeper.cluster.ZooKeeperClusterService
|====
-On Spring/Blueprint all the _Cluster Service_ instances are automatically added to the camel context.
-
Configuration examples:
- *Spring Boot*
@@ -73,7 +71,6 @@ camel.cluster.file.root = ${java.io.tmpdir}
http://camel.apache.org/schema/spring
http://camel.apache.org/schema/spring/camel-spring.xsd">
-
<bean id="zx" class="org.apache.camel.component.zookeeper.cluster.ZooKeeperClusterService">
<property name="id" value="node-1"/>
<property name="basePath" value="/camel/cluster"/>
diff --git a/docs/user-manual/modules/ROOT/pages/dsl.adoc b/docs/user-manual/modules/ROOT/pages/dsl.adoc
index 359be0d..315c9dd 100644
--- a/docs/user-manual/modules/ROOT/pages/dsl.adoc
+++ b/docs/user-manual/modules/ROOT/pages/dsl.adoc
@@ -9,8 +9,6 @@ languages (DSL) as listed below.
* xref:java-dsl.adoc[Java DSL] - A Java based DSL using the fluent
builder style.
* xref:components::spring-summary.adoc[Spring XML] - A XML based DSL in Spring XML files
-* xref:using-osgi-blueprint-with-camel.adoc[Blueprint XML] - A XML based
-DSL in OSGi Blueprint XML files
* xref:rest-dsl.adoc[Rest DSL] - A DSL to define REST services using a
REST style in either Java or XML.
* xref:bean-integration.adoc[Annotation DSL] - Use annotations in Java
diff --git a/docs/user-manual/modules/ROOT/pages/health-check.adoc b/docs/user-manual/modules/ROOT/pages/health-check.adoc
index 4ee938a..11450fb 100644
--- a/docs/user-manual/modules/ROOT/pages/health-check.adoc
+++ b/docs/user-manual/modules/ROOT/pages/health-check.adoc
@@ -150,8 +150,9 @@ public final class MyHealthCheck extends AbstractHealthCheck {
}
----
-You can now make _MyHealthCheck_ available to Camel by adding an instance to the application context (Spring, Blueprint) or directly to the registry.
-The example `camel-example-main-health` has a custom health check.
+You can now make _MyHealthCheck_ available to Camel by adding an instance to (for example Spring application context) or directly to the Camel xref:registry.adoc[Registry].
+
+TIP: The example `camel-example-main-health` has a custom health check.
== Examples
diff --git a/docs/user-manual/modules/ROOT/pages/index.adoc b/docs/user-manual/modules/ROOT/pages/index.adoc
index 31d529e..7582c82 100644
--- a/docs/user-manual/modules/ROOT/pages/index.adoc
+++ b/docs/user-manual/modules/ROOT/pages/index.adoc
@@ -59,7 +59,6 @@ For a deeper and better understanding of Apache Camel, an xref:faq:what-is-camel
* xref:camel-report-maven-plugin.adoc[Camel Maven Report Plugin] to validate your source code and report the code coverage of your camel routes
* xref:camel-maven-archetypes.adoc[Camel Maven Archetypes]
* xref:components::jmx-component.adoc[Camel JMX]
-* xref:using-osgi-blueprint-with-camel.adoc[Using OSGi blueprint with Camel]
* xref:rest-dsl.adoc[Working with REST and Rest DSL]
* xref:writing-components.adoc[Writing Custom Camel Components]
@@ -114,7 +113,6 @@ For a deeper and better understanding of Apache Camel, an xref:faq:what-is-camel
* xref:java-dsl.adoc[Java DSL]
* xref:bean-integration.adoc[Java Annotation DSL]
* xref:components::spring-summary.adoc[Spring XML DSL]
-* xref:using-osgi-blueprint-with-camel.adoc[OSGi Blueprint XML DSL]
* xref:rest-dsl.adoc[Rest DSL]
== Developers
diff --git a/docs/user-manual/modules/ROOT/pages/testing.adoc b/docs/user-manual/modules/ROOT/pages/testing.adoc
index 688e44f..dde60e4 100644
--- a/docs/user-manual/modules/ROOT/pages/testing.adoc
+++ b/docs/user-manual/modules/ROOT/pages/testing.adoc
@@ -52,10 +52,6 @@ parity with the plain JUnit 3.x/4.x based testing approach. Notice
older Camel release use `camel-test` which has built-in
Spring Testing.
-|Blueprint Testing |camel-test-blueprint
-|*Camel 2.10:* Provides the ability to do unit testing on blueprint
-configurations
-
|=======================================================================
In all approaches the test classes look pretty much the same in that
@@ -177,18 +173,6 @@ to support the features of `CamelTestSupport` through annotations on
the test class. See Spring Testing for a list
of annotations you can use in your tests.
-[[Testing-BlueprintTest]]
-=== Blueprint Test
-
-Here is the Blueprint Testing
-https://github.com/apache/camel-karaf/blob/main/components/camel-test-blueprint/src/test/java/org/apache/camel/test/blueprint/DebugBlueprintTest.java[example
-using XML Config]:
-
-Also notice the use of `getBlueprintDescriptors` to indicate that by
-default we should look for the
-https://github.com/apache/camel-karaf/blob/main/components/camel-test-blueprint/src/test/resources/org/apache/camel/test/blueprint/camelContext.xml[`camelContext.xml`
-in the package] to configure the test case which looks like this:
-
[[Testing-Testingendpoints]]
== Testing endpoints
diff --git a/docs/user-manual/modules/ROOT/pages/using-osgi-blueprint-with-camel.adoc b/docs/user-manual/modules/ROOT/pages/using-osgi-blueprint-with-camel.adoc
deleted file mode 100644
index d5a05de..0000000
--- a/docs/user-manual/modules/ROOT/pages/using-osgi-blueprint-with-camel.adoc
+++ /dev/null
@@ -1,60 +0,0 @@
-[[UsingOSGiblueprintwithCamel-UsingOSGiblueprintwithCamel]]
-= Using OSGi blueprint with Camel
-
-*Since Camel 2.4*
-
-A custom XML namespace for Blueprint has been created to let you
-leverage the nice XML dialect. Given Blueprint custom namespaces are not
-standardized yet, this namespace can only be used on the
-http://incubator.apache.org/aries/[Apache Aries] Blueprint
-implementation, which is the one used by http://karaf.apache.org[Apache
-Karaf].
-
-[[UsingOSGiblueprintwithCamel-Overview]]
-== Overview
-
-The XML schema is mostly the same as the one for Spring, so all the xml
-snippets throughout the documentation referring to Spring XML also apply
-to Blueprint routes.
-
-Here is a very simple route definition using blueprint:
-
-[source,xml]
--------------------------------------------------------------------
-<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0">
-
- <camelContext xmlns="http://camel.apache.org/schema/blueprint">
- <route>
- <from uri="timer:test" />
- <to uri="log:test" />
- </route>
- </camelContext>
-
-</blueprint>
--------------------------------------------------------------------
-
-There are a few limitations at this point about the supported xml
-elements (compared to the Spring xml syntax):
-
-* beanPostProcessor are specific to Spring and aren't allowed
-
-However, using blueprint when you deploy your applications in an OSGi
-environment has several advantages:
-
-* when upgrading to a new camel version, you don't have to change the
-namespace, as the correct version will be selected based on the camel
-packages that are imported by your bundle
-* no startup ordering issue with respect to the custom namespaces and
-your bundles
-* you can use Blueprint property placeholders, see more at
-xref:using-propertyplaceholder.adoc[Using PropertyPlaceholder]
-
-[[UsingOSGiblueprintwithCamel-Usingcamel-blueprint]]
-== Using camel-blueprint
-
-To leverage camel-blueprint in OSGi, you only need the Aries Blueprint
-bundle and the camel-blueprint bundle, in addition to camel-core and its
-dependencies.
-
-If you use Karaf, you can use the feature named `camel-blueprint` which
-will install all the required bundles.
diff --git a/docs/user-manual/modules/faq/pages/what-is-camel.adoc b/docs/user-manual/modules/faq/pages/what-is-camel.adoc
index b57c089..34d1633 100644
--- a/docs/user-manual/modules/faq/pages/what-is-camel.adoc
+++ b/docs/user-manual/modules/faq/pages/what-is-camel.adoc
@@ -25,8 +25,7 @@ out-of-box.
Apache Camel provides support for xref:ROOT:bean-binding.adoc[Bean Binding]
and seamless integration with popular frameworks such as
-xref:components:others:cdi.adoc[CDI], xref:ROOT:spring.adoc[Spring] and
-xref:ROOT:using-osgi-blueprint-with-camel.adoc[Blueprint].
+xref:components:others:cdi.adoc[CDI], xref:ROOT:spring.adoc[Spring].
Camel also has extensive support for
xref:ROOT:testing.adoc[unit testing] your routes.