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 2017/02/15 13:36:29 UTC

[2/3] camel git commit: Polished

Polished


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

Branch: refs/heads/master
Commit: dc46f50d84d22792277fe3eb480c4071e15506a7
Parents: a5513e7
Author: Claus Ibsen <da...@apache.org>
Authored: Wed Feb 15 14:28:50 2017 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Wed Feb 15 14:28:50 2017 +0100

----------------------------------------------------------------------
 examples/README.adoc                                 |  6 +++---
 .../camel-example-servlet-tomcat-no-spring/README.md |  8 ++------
 examples/camel-example-servlet-tomcat/README.md      |  5 -----
 examples/camel-example-simplejirabot/README.md       |  4 ----
 .../readme.adoc                                      |  2 +-
 examples/camel-example-spring-boot/readme.adoc       | 14 ++++++++++----
 examples/camel-example-spring-javaconfig/README.md   |  3 ---
 examples/camel-example-spring-jms/README.md          |  4 ----
 examples/camel-example-spring-security/README.md     |  3 ---
 examples/camel-example-spring-ws/README.md           |  8 +++-----
 examples/camel-example-spring-xquery/README.md       |  3 ---
 examples/camel-example-spring/README.md              |  4 ----
 examples/camel-example-sql-blueprint/README.md       |  3 ---
 examples/camel-example-sql/README.md                 |  3 ---
 examples/camel-example-tracer/README.md              |  8 --------
 examples/camel-example-tracer/pom.xml                |  2 +-
 .../README.md                                        |  7 -------
 examples/camel-example-twitter-websocket/README.md   |  5 -----
 examples/camel-example-widget-gadget-cdi/README.md   |  5 -----
 examples/camel-example-widget-gadget-java/README.md  |  5 -----
 examples/camel-example-widget-gadget-xml/README.md   |  5 -----
 examples/camel-example-zipkin/README.md              | 15 +++++++++++++++
 22 files changed, 35 insertions(+), 87 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/README.adoc
----------------------------------------------------------------------
diff --git a/examples/README.adoc b/examples/README.adoc
index 554dfe4..8af837d 100644
--- a/examples/README.adoc
+++ b/examples/README.adoc
@@ -105,7 +105,7 @@ Number of Examples: 83
 
 | link:camel-example-spring-boot-metrics/README.md[Spring Boot Metrics] (camel-example-spring-boot-metrics) | Management and Monitoring | An example showing how to work with Camel and Spring Boot and report metrics to Graphite
 
-| link:camel-example-tracer/README.md[Tracer] (camel-example-tracer) | Management and Monitoring | An example showing how to persist Camel trace event messages using JPA
+| link:camel-example-tracer/README.md[Tracer] (camel-example-tracer) | Management and Monitoring | *deprecated* An example showing how to persist Camel trace event messages using JPA
 
 | link:camel-example-zipkin/README.md[Zipkin] (camel-example-zipkin) | Management and Monitoring | An example showing how to trace incoming and outgoing messages from Camel with Zipkin
 
@@ -115,7 +115,7 @@ Number of Examples: 83
 
 | link:camel-example-jms-file/README.md[JMS-File] (camel-example-jms-file) | Messaging | An example that persists messages from JMS to files
 
-| link:camel-example-kafka/README.md[Kafka] (camel-example-kafka) | Messaging | An example for Kafka
+| link:camel-example-kafka/README.adoc[Kafka] (camel-example-kafka) | Messaging | An example for Kafka
 
 | link:camel-example-spring-jms/README.md[Spring JMS] (camel-example-spring-jms) | Messaging | An example using Spring XML to talk to the JMS server from different kind of client techniques
 
@@ -129,7 +129,7 @@ Number of Examples: 83
 
 | link:camel-example-netty-http/README.md[Netty HTTP] (camel-example-netty-http) | OSGi | An example showing how to use a shared Netty HTTP server with multiple Camel applications in OSGi container
 
-| link:camel-example-osgi-rmi/README.md[OSGi RMI] (camel-example-osgi-rmi) | OSGi | A OSGi example which exposes a RMI service.
+| link:camel-example-osgi-rmi/README.md[OSGi RMI] (camel-example-osgi-rmi) | OSGi | *deprecated* A OSGi example which exposes a RMI service.
 
 | link:camel-example-servlet-rest-blueprint/README.md[Servlet REST Blueprint] (camel-example-servlet-rest-blueprint) | OSGi | An example using Servlet REST with OSGi Blueprint
 

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-servlet-tomcat-no-spring/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-servlet-tomcat-no-spring/README.md b/examples/camel-example-servlet-tomcat-no-spring/README.md
index ae97571..e81021e 100644
--- a/examples/camel-example-servlet-tomcat-no-spring/README.md
+++ b/examples/camel-example-servlet-tomcat-no-spring/README.md
@@ -6,7 +6,8 @@ without using the Spring Framework.
 
 ### Build
 You will need to package this example first:
-  mvn package
+
+    mvn package
 
 ### Run
 To run the example deploy it in Apache Tomcat by copying the `.war` to the
@@ -22,11 +23,6 @@ The servlet is located at
 	http://localhost:8080/camel-example-servlet-tomcat-no-spring/camel
 <http://localhost:8080/camel-example-servlet-tomcat-no-spring/camel>
 
-### Documentation
-
-This example is documented at
-  <http://camel.apache.org/servlet-tomcat-example-no-spring.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-servlet-tomcat/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-servlet-tomcat/README.md b/examples/camel-example-servlet-tomcat/README.md
index e35557b..00f469e 100644
--- a/examples/camel-example-servlet-tomcat/README.md
+++ b/examples/camel-example-servlet-tomcat/README.md
@@ -25,11 +25,6 @@ The servlet is located at
 	http://localhost:8080/camel-example-servlet-tomcat/camel/hello
 <http://localhost:8080/camel-example-servlet-tomcat/camel/hello>
 
-### Documentation
-
-This example is documented at
-  <http://camel.apache.org/servlet-tomcat-example.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-simplejirabot/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-simplejirabot/README.md b/examples/camel-example-simplejirabot/README.md
index a5d2c89..d66d30d 100644
--- a/examples/camel-example-simplejirabot/README.md
+++ b/examples/camel-example-simplejirabot/README.md
@@ -31,10 +31,6 @@ You can see the routing rules by looking at the java code in the
 
 To stop the example hit <kbd>ctrl</kbd>+<kbd>c</kbd>
 
-### Documentation
-
-This example is documented at <http://camel.apache.org/simple-jira-bot.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-spring-boot-live-reload/readme.adoc
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-boot-live-reload/readme.adoc b/examples/camel-example-spring-boot-live-reload/readme.adoc
index 3498a68..98b93c8 100644
--- a/examples/camel-example-spring-boot-live-reload/readme.adoc
+++ b/examples/camel-example-spring-boot-live-reload/readme.adoc
@@ -8,7 +8,7 @@ LiveReload browser extensions are freely available for the most popular browsers
 
 The example should be launched with the following maven command:
 
- mvn clean install spring-boot:run
+   mvn spring-boot:run
 
 Once the application is started, you can visit http://localhost:8080/ with a browser and activate the LiveReload feature
 (usually, by clicking on the extension's icon).

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-spring-boot/readme.adoc
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-boot/readme.adoc b/examples/camel-example-spring-boot/readme.adoc
index 242fc01..8520753 100644
--- a/examples/camel-example-spring-boot/readme.adoc
+++ b/examples/camel-example-spring-boot/readme.adoc
@@ -1,20 +1,26 @@
-= Camel Example Spring Boot
+# Camel Example Spring Boot
 
 This example shows how to work with a simple Apache Camel application using Spring Boot.
 
 The example generates messages using timer trigger, writes them to standard output.
 
-== Camel routes
+## Camel routes
 
 The Camel route is located in the `SampleCamelRouter` class. In this class the route
 starts from a timer, that triggers every 2nd second and calls a Spring Bean `SampleBean`
 which returns a message, that is routed to a stream endpoint which writes to standard output.
 
-== Using Camel components
+## Using Camel components
 
 Apache Camel provides 200+ components which you can use to integrate and route messages between many systems
 and data formats. To use any of these Camel components, add the component as a dependency to your project.
 
-== More information
+## How to run
+
+You can run this example using
+
+    mvn spring-boot:run
+
+## More information
 
 You can find more information about Apache Camel at the website: http://camel.apache.org/

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-spring-javaconfig/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-javaconfig/README.md b/examples/camel-example-spring-javaconfig/README.md
index eec374f..712b26a 100644
--- a/examples/camel-example-spring-javaconfig/README.md
+++ b/examples/camel-example-spring-javaconfig/README.md
@@ -25,9 +25,6 @@ To stop the example hit <kbd>ctrl</kbd>+<kbd>c</kbd>
 You can see the routing rules by looking at the java code in the
 `src/main/java directory`
 
-### Documentation
-This example is documented at <http://camel.apache.org/spring-java-config-example.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-spring-jms/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-jms/README.md b/examples/camel-example-spring-jms/README.md
index 32fc41e..9a5f324 100644
--- a/examples/camel-example-spring-jms/README.md
+++ b/examples/camel-example-spring-jms/README.md
@@ -31,10 +31,6 @@ The example should run if you type:
 
 To stop the example hit <kbd>ctrl</kbd>+<kbd>c</kbd>
 
-### Documentation
-
-This example is documented at <http://camel.apache.org/tutorial-jmsremoting.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-spring-security/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-security/README.md b/examples/camel-example-spring-security/README.md
index eb6d828..d75e322 100644
--- a/examples/camel-example-spring-security/README.md
+++ b/examples/camel-example-spring-security/README.md
@@ -23,9 +23,6 @@ Then you can use the script in the client directory to send the request and chec
 or use browser to access upper urls with the user/password
 (`jim/jimspassword` with the admin and user role  or `bob/bobspassword` with user role).
 
-### Documentation
-This example is documented at <http://camel.apache.org/spring-security-example.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-spring-ws/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-ws/README.md b/examples/camel-example-spring-ws/README.md
index 44f88f4..5a5e587 100644
--- a/examples/camel-example-spring-ws/README.md
+++ b/examples/camel-example-spring-ws/README.md
@@ -5,12 +5,13 @@ This example shows how to expose a SOAP-based web service using Camel and Spring
 
 ### Build
 You will need to compile this example first:
-  mvn clean install
+  
+    mvn clean install
 
 ### Run
 To run the example, you need to start up the server by typing
 
-	mvn jetty:run
+	  mvn jetty:run
 
 To stop the server hit <kbd>ctrl</kbd>+<kbd>c</kbd>
 
@@ -25,9 +26,6 @@ The WSDL is available at:
 You can test the web service using for example SOAP-UI. This excellent tool is freely available from http://www.soapui.org.
 There's a ready to use SOAP-UI project available in the `client` directory.
 
-### Documentation
-This example is documented at <http://camel.apache.org/spring-ws-example.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-spring-xquery/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-xquery/README.md b/examples/camel-example-spring-xquery/README.md
index 743c39a..99ae037 100644
--- a/examples/camel-example-spring-xquery/README.md
+++ b/examples/camel-example-spring-xquery/README.md
@@ -25,9 +25,6 @@ at `src/main/resources/META-INF/spring`
 
 To stop the example hit <kbd>ctrl</kbd>+<kbd>c</kbd>
 
-### Documentation
-This example is documented at <http://camel.apache.org/spring-xquery-example.html>
-
 
 ### Forum, Help, etc
 

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-spring/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring/README.md b/examples/camel-example-spring/README.md
index c3686c3..4747026 100644
--- a/examples/camel-example-spring/README.md
+++ b/examples/camel-example-spring/README.md
@@ -24,10 +24,6 @@ You can see the routing rules by looking at the java code in the
 
 To stop the example hit <kbd>ctrl</kbd>+<kbd>c</kbd>
 
-### Documentation
-
-This example is documented at <http://camel.apache.org/spring-example.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-sql-blueprint/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-sql-blueprint/README.md b/examples/camel-example-sql-blueprint/README.md
index b7aa857..826c360 100644
--- a/examples/camel-example-sql-blueprint/README.md
+++ b/examples/camel-example-sql-blueprint/README.md
@@ -56,9 +56,6 @@ And you can see the application running by tailing the logs
 
 And you can use <kbd>ctrl</kbd>+<kbd>c</kbd> to stop tailing the log.
 
-### Documentation
-This example is documented at <http://camel.apache.org/sql-example-blueprint.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-sql/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-sql/README.md b/examples/camel-example-sql/README.md
index f2d0bd4..455868d 100644
--- a/examples/camel-example-sql/README.md
+++ b/examples/camel-example-sql/README.md
@@ -56,9 +56,6 @@ And you can see the application running by tailing the logs
 
 And you can use <kbd>ctrl</kbd>+<kbd>c</kbd> to stop tailing the log.
 
-### Documentation
-This example is documented at <http://camel.apache.org/sql-example.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-tracer/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-tracer/README.md b/examples/camel-example-tracer/README.md
index 8860ee2..0724ff2 100644
--- a/examples/camel-example-tracer/README.md
+++ b/examples/camel-example-tracer/README.md
@@ -25,14 +25,6 @@ to return as response in the console.
 
 To stop the example hit <kbd>ctrl</kbd>+<kbd>c</kbd>
 
-### Documentation
-
-For a background in tracer and JPA see
-  http://camel.apache.org/tracer.html
-  http://camel.apache.org/jpa.html
-
-This example is documented at <http://camel.apache.org/tracer-example.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-tracer/pom.xml
----------------------------------------------------------------------
diff --git a/examples/camel-example-tracer/pom.xml b/examples/camel-example-tracer/pom.xml
index 978d123..8dfd49a 100644
--- a/examples/camel-example-tracer/pom.xml
+++ b/examples/camel-example-tracer/pom.xml
@@ -28,7 +28,7 @@
 
   <artifactId>camel-example-tracer</artifactId>
   <packaging>jar</packaging>
-  <name>Camel :: Example :: Tracer</name>
+  <name>Camel :: Example :: Tracer (deprecated)</name>
   <description>An example showing how to persist Camel trace event messages using JPA</description>
 
   <properties>

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-twitter-websocket-blueprint/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-twitter-websocket-blueprint/README.md b/examples/camel-example-twitter-websocket-blueprint/README.md
index 57e285e..fd7c05e 100644
--- a/examples/camel-example-twitter-websocket-blueprint/README.md
+++ b/examples/camel-example-twitter-websocket-blueprint/README.md
@@ -44,13 +44,6 @@ To stop the example run from Karaf/ServiceMix shell:
 eg if the bundle id is 99 then type:
   stop 99
 
-### Documentation
-We have described this in more details at the Camel twitter documentation: <http://camel.apache.org/twitter>
-
-This example is documented at <http://camel.apache.org/twitter-websocket-blueprint-example.html>
-
-There is a regular (non OSGi Blueprint) example as well documented at: <http://camel.apache.org/twitter-websocket-example.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-twitter-websocket/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-twitter-websocket/README.md b/examples/camel-example-twitter-websocket/README.md
index 5fe7269..ef6db6b 100644
--- a/examples/camel-example-twitter-websocket/README.md
+++ b/examples/camel-example-twitter-websocket/README.md
@@ -28,11 +28,6 @@ Then open a browser to see live twitter updates in the web page
 To stop the example hit <kbd>ctrl</kbd>+<kbd>c</kbd>
 
 
-### Documentation
-We have described this in more details at the Camel twitter documentation: <http://camel.apache.org/twitter>
-
-This example is documented at <http://camel.apache.org/twitter-websocket-example.html>
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-widget-gadget-cdi/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-widget-gadget-cdi/README.md b/examples/camel-example-widget-gadget-cdi/README.md
index 0ae4bab..941e8be 100644
--- a/examples/camel-example-widget-gadget-cdi/README.md
+++ b/examples/camel-example-widget-gadget-cdi/README.md
@@ -67,11 +67,6 @@ The Camel application can be stopped pressing <kbd>ctrl</kbd>+<kbd>c</kbd> in th
 
 The Camel application is configured in the `org.apache.camel.example.widget.WidgetApplication.java` file.
 
-### Documentation
-
-This example is documented at
-	<http://camel.apache.org/widget-gadget.html>
-
 ### Forum, Help, etc 
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-widget-gadget-java/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-widget-gadget-java/README.md b/examples/camel-example-widget-gadget-java/README.md
index cd04fb9..dcd62a1 100644
--- a/examples/camel-example-widget-gadget-java/README.md
+++ b/examples/camel-example-widget-gadget-java/README.md
@@ -65,11 +65,6 @@ The Camel application can be stopped pressing <kbd>ctrl</kbd>+<kbd>c</kbd> in th
 
 The Camel application is configured in the `src/main/java/org/apache/camel/example/widget/WidgetMain.java` file.
 
-### Documentation
-
-This example is documented at
-	[http://camel.apache.org/widget-gadget.html](http://camel.apache.org/widget-gadget.html)
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-widget-gadget-xml/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-widget-gadget-xml/README.md b/examples/camel-example-widget-gadget-xml/README.md
index 9cbc8d8..77eaf42 100644
--- a/examples/camel-example-widget-gadget-xml/README.md
+++ b/examples/camel-example-widget-gadget-xml/README.md
@@ -66,11 +66,6 @@ The Camel application can be stopped pressing <kbd>ctrl</kbd>+<kbd>c</kbd> in th
 
 The Camel application is configured in the `src/main/resources/META-INF/spring/widget.xml` file.
 
-### Documentation
-
-This example is documented at
-	[http://camel.apache.org/widget-gadget.html](http://camel.apache.org/widget-gadget.html)
-
 ### Forum, Help, etc
 
 If you hit an problems please let us know on the Camel Forums

http://git-wip-us.apache.org/repos/asf/camel/blob/dc46f50d/examples/camel-example-zipkin/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-zipkin/README.md b/examples/camel-example-zipkin/README.md
index b22e423..8658a6b 100644
--- a/examples/camel-example-zipkin/README.md
+++ b/examples/camel-example-zipkin/README.md
@@ -66,6 +66,21 @@ You can then click on each span and get annotated data from the Camel exchange a
 ![Zipkin Web Console Span Details](images/zipkin-web-console-2.png "Detail of the span")
 
 
+### Installing Zipkin Server 
+
+If you want to try Zipkin locally then you quickly download an uber JAR (standalone-hystrix-dashboard) 
+
+  <http://search.maven.org/remotecontent?filepath=com/github/kennedyoliveira/standalone-hystrix-dashboard/1.5.3/standalone-hystrix-dashboard-1.5.3-all.jar>
+    
+.. and then run it
+    
+    java -jar standalone-hystrix-dashboard-1.5.3-all.jar
+     
+And the console is available at:
+     
+    http://localhost:7979/hystrix-dashboard/
+
+
 ### Installing Zipkin Server using Docker
 
 If you want to try Zipkin locally then you quickly try that using Docker.