From ef369d9ee223fac6d2ad054076df1f7f6dc382f6 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Mon, 23 May 2016 10:08:54 +0200 Subject: [PATCH] Updated docs with missing starter dep In the docs we needed to add the dependency to starter-sleuth, that way all the necessary dependencies are downloaded to the project fixes #281 --- README.adoc | 30 ++++++++++++++++++++++-------- docs/src/main/asciidoc/intro.adoc | 30 ++++++++++++++++++++++-------- 2 files changed, 44 insertions(+), 16 deletions(-) diff --git a/README.adoc b/README.adoc index 7d176f608..b4100f602 100644 --- a/README.adoc +++ b/README.adoc @@ -259,8 +259,12 @@ If you want both Sleuth and Zipkin just add the `spring-cloud-sleuth-stream` dep org.springframework.cloud spring-cloud-sleuth-stream - <3> + org.springframework.cloud + spring-cloud-starter-sleuth + + + <4> org.springframework.cloud spring-cloud-stream-binder-rabbit @@ -268,7 +272,8 @@ If you want both Sleuth and Zipkin just add the `spring-cloud-sleuth-stream` dep <1> In order not to pick versions by yourself it's much better if you add the dependency management via the Spring BOM <2> Add the dependency to `spring-cloud-sleuth-stream` -<3> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to +<3> Add the dependency to `spring-cloud-starter-sleuth` - that way all dependant dependencies will be downloaded +<4> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to [source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] .Gradle @@ -281,14 +286,16 @@ dependencyManagement { <1> dependencies { compile "org.springframework.cloud:spring-cloud-sleuth-stream" <2> + compile "org.springframework.cloud:spring-cloud-starter-sleuth" <3> // Example for Rabbit binding - compile "org.springframework.cloud:spring-cloud-stream-binder-rabbit" <3> + compile "org.springframework.cloud:spring-cloud-stream-binder-rabbit" <4> } ---- <1> In order not to pick versions by yourself it's much better if you add the dependency management via the Spring BOM <2> Add the dependency to `spring-cloud-sleuth-stream` -<3> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to +<3> Add the dependency to `spring-cloud-starter-sleuth` - that way all dependant dependencies will be downloaded +<4> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to ==== Spring Cloud Sleuth Stream Zipkin Collector @@ -314,8 +321,12 @@ dependency org.springframework.cloud spring-cloud-sleuth-zipkin-stream - <3> + org.springframework.cloud + spring-cloud-starter-sleuth + + + <4> org.springframework.cloud spring-cloud-stream-binder-rabbit @@ -323,7 +334,8 @@ dependency <1> In order not to pick versions by yourself it's much better if you add the dependency management via the Spring BOM <2> Add the dependency to `spring-cloud-sleuth-zipkin-stream` -<3> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to +<3> Add the dependency to `spring-cloud-starter-sleuth` - that way all dependant dependencies will be downloaded +<4> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to [source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] .Gradle @@ -336,14 +348,16 @@ dependencyManagement { <1> dependencies { compile "org.springframework.cloud:spring-cloud-sleuth-zipkin-stream" <2> + compile "org.springframework.cloud:spring-cloud-starter-sleuth" <3> // Example for Rabbit binding - compile "org.springframework.cloud:spring-cloud-stream-binder-rabbit" <3> + compile "org.springframework.cloud:spring-cloud-stream-binder-rabbit" <4> } ---- <1> In order not to pick versions by yourself it's much better if you add the dependency management via the Spring BOM <2> Add the dependency to `spring-cloud-sleuth-zipkin-stream` -<3> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to +<3> Add the dependency to `spring-cloud-starter-sleuth` - that way all dependant dependencies will be downloaded +<4> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to and then just annotate your main class with `@EnableZipkinStreamServer` annotation: diff --git a/docs/src/main/asciidoc/intro.adoc b/docs/src/main/asciidoc/intro.adoc index ff8215f30..7124f2af3 100644 --- a/docs/src/main/asciidoc/intro.adoc +++ b/docs/src/main/asciidoc/intro.adoc @@ -251,8 +251,12 @@ If you want both Sleuth and Zipkin just add the `spring-cloud-sleuth-stream` dep org.springframework.cloud spring-cloud-sleuth-stream - <3> + org.springframework.cloud + spring-cloud-starter-sleuth + + + <4> org.springframework.cloud spring-cloud-stream-binder-rabbit @@ -260,7 +264,8 @@ If you want both Sleuth and Zipkin just add the `spring-cloud-sleuth-stream` dep <1> In order not to pick versions by yourself it's much better if you add the dependency management via the Spring BOM <2> Add the dependency to `spring-cloud-sleuth-stream` -<3> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to +<3> Add the dependency to `spring-cloud-starter-sleuth` - that way all dependant dependencies will be downloaded +<4> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to [source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] .Gradle @@ -273,14 +278,16 @@ dependencyManagement { <1> dependencies { compile "org.springframework.cloud:spring-cloud-sleuth-stream" <2> + compile "org.springframework.cloud:spring-cloud-starter-sleuth" <3> // Example for Rabbit binding - compile "org.springframework.cloud:spring-cloud-stream-binder-rabbit" <3> + compile "org.springframework.cloud:spring-cloud-stream-binder-rabbit" <4> } ---- <1> In order not to pick versions by yourself it's much better if you add the dependency management via the Spring BOM <2> Add the dependency to `spring-cloud-sleuth-stream` -<3> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to +<3> Add the dependency to `spring-cloud-starter-sleuth` - that way all dependant dependencies will be downloaded +<4> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to ==== Spring Cloud Sleuth Stream Zipkin Collector @@ -306,8 +313,12 @@ dependency org.springframework.cloud spring-cloud-sleuth-zipkin-stream - <3> + org.springframework.cloud + spring-cloud-starter-sleuth + + + <4> org.springframework.cloud spring-cloud-stream-binder-rabbit @@ -315,7 +326,8 @@ dependency <1> In order not to pick versions by yourself it's much better if you add the dependency management via the Spring BOM <2> Add the dependency to `spring-cloud-sleuth-zipkin-stream` -<3> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to +<3> Add the dependency to `spring-cloud-starter-sleuth` - that way all dependant dependencies will be downloaded +<4> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to [source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] .Gradle @@ -328,14 +340,16 @@ dependencyManagement { <1> dependencies { compile "org.springframework.cloud:spring-cloud-sleuth-zipkin-stream" <2> + compile "org.springframework.cloud:spring-cloud-starter-sleuth" <3> // Example for Rabbit binding - compile "org.springframework.cloud:spring-cloud-stream-binder-rabbit" <3> + compile "org.springframework.cloud:spring-cloud-stream-binder-rabbit" <4> } ---- <1> In order not to pick versions by yourself it's much better if you add the dependency management via the Spring BOM <2> Add the dependency to `spring-cloud-sleuth-zipkin-stream` -<3> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to +<3> Add the dependency to `spring-cloud-starter-sleuth` - that way all dependant dependencies will be downloaded +<4> Add a binder (e.g. Rabbit binder) to tell Spring Cloud Stream what it should bind to and then just annotate your main class with `@EnableZipkinStreamServer` annotation: