Setup root project documentation landing page.

fixes gh-14
2015-06-26 11:05:00 -06:00
parent 0182c2000f
commit 82fac1f7d9
3 changed files with 89 additions and 13 deletions
--- a/_includes/build.gradle
+++ b/_includes/build.gradle
@@ -1,3 +1,3 @@
 dependencies {
-    compile '{@= groupId @}:spring-cloud-starter-zookeeper:{@= version @}'
+    compile '{@= groupId @}:spring-cloud-starter-zookeeper-all:{@= version @}'
 }
--- a/_includes/pom.xml
+++ b/_includes/pom.xml
@@ -1,17 +1,7 @@
-<dependencyManagement>
-    <dependencies>
-        <dependency>
-            <groupId>{@= groupId @}</groupId>
-            <artifactId>spring-cloud-starter-parent</artifactId>
-            <version>{@= version @}</version>
-            <type>pom</type>
-            <scope>import</scope>
-        </dependency>
-    </dependencies>
-</dependencyManagement>
 <dependencies>
    <dependency>
        <groupId>{@= groupId @}</groupId>
-        <artifactId>spring-cloud-starter-zookeeper</artifactId>
+        <artifactId>spring-cloud-starter-zookeeper-all</artifactId>
+        <version>{@= version @}</version>
    </dependency>
 </dependencies>
--- a/index.html
+++ b/index.html
@@ -0,0 +1,86 @@
+---
+# The name of your project
+title: Spring Cloud Zookeeper
+
+badges:
+
+  # Customize your project's badges. Delete any entries that do not apply.
+  custom:
+    - name: Source (GitHub)
+      url:  https://github.com/spring-cloud/spring-cloud-zookeeper
+      icon: github
+
+    - name: StackOverflow
+      url:  http://stackoverflow.com/questions/tagged/spring-cloud
+      icon: stackoverflow
+
+---
+<!DOCTYPE HTML>
+<html lang="en-US">
+
+<!-- Specify the parent of this project (or delete if none) to influence the rendering of the breadcrumb -->
+{% capture parent_link %}
+[Spring Cloud]({{ site.projects_site_url }}/spring-cloud)
+{% endcapture %}
+
+
+{% capture billboard_description %}
+
+Spring Cloud Zookeeper provides [Apache Zookeeper](http://zookeeper.apache.org/) integrations for Spring Boot apps through autoconfiguration and binding to the Spring Environment and other Spring programming model idioms. With a few simple annotations you can quickly enable and configure the common patterns inside your application and build large distributed systems with Zookeeper. The patterns provided include Service Discovery and Distributed Configuration.
+
+{% endcapture %}
+
+{% capture main_content %}
+
+## Features
+
+Spring Cloud Zookeeper features:
+
+* Service Discovery: instances can be registered with Zookeeper and clients can discover the instances using Spring-managed beans
+ * Supports Ribbon, the client side load-balancer via Spring Cloud Netflix
+ * Supports Zuul, a dynamic router and filter via Spring Cloud Netflix
+* Distributed Configuration: using Zookeeper as a data store
+
+<span id="quick-start"></span>
+## Quick Start
+
+{% include download_widget.md %}
+
+As long as Spring Cloud Zookeeper, [Apache Curator](http://curator.apache.org/) and the Zookeeper Java Client are on the
+classpath any Spring Boot application with `@EnableDiscoveryClient` will try to contact a Zookeeper
+agent on `localhost:2181` (the default value of
+`zookeeper.connectString`).
+
+```java
+@Configuration
+@EnableAutoConfiguration
+@EnableDiscoveryClient
+@RestController
+public class Application {
+
+  @RequestMapping("/")
+  public String home() {
+    return "Hello World";
+  }
+
+  public static void main(String[] args) {
+    SpringApplication.run(Application.class, args);
+  }
+
+}
+```
+
+A local Zookeeper server must be running.  See the [Zookeeper documentation](http://zookeeper.apache.org/doc/trunk/zookeeperStarted.html) on how to run a Zookeeper server.
+
+{% endcapture %}
+
+{% capture related_resources %}
+
+### Sample Projects
+
+* [Zookeeper Sample](https://github.com/spring-cloud/spring-cloud-zookeeper/tree/master/spring-cloud-zookeeper-sample)
+
+{% endcapture %}
+
+{% include project_page.html %}
+</html>