You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@curator.apache.org by ra...@apache.org on 2013/03/27 02:11:18 UTC
[23/52] [abbrv] git commit: Added examples doc
Added examples doc
Project: http://git-wip-us.apache.org/repos/asf/incubator-curator/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-curator/commit/e6e59866
Tree: http://git-wip-us.apache.org/repos/asf/incubator-curator/tree/e6e59866
Diff: http://git-wip-us.apache.org/repos/asf/incubator-curator/diff/e6e59866
Branch: refs/heads/master
Commit: e6e598666211afe7d4c966bf7b8b5079afd8e6ad
Parents: c43ddc5
Author: Jordan Zimmerman <jo...@jordanzimmerman.com>
Authored: Sun Mar 10 10:17:31 2013 -0700
Committer: Jordan Zimmerman <jo...@jordanzimmerman.com>
Committed: Sun Mar 10 10:17:31 2013 -0700
----------------------------------------------------------------------
.../src/site/confluence/index.confluence | 11 ++++++
curator-examples/src/site/resources/css/site.css | 4 ++
curator-examples/src/site/site.xml | 27 +++++++++++++++
src/site/confluence/getting-started.confluence | 4 --
src/site/confluence/index.confluence | 1 +
src/site/site.xml | 1 +
6 files changed, 44 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/e6e59866/curator-examples/src/site/confluence/index.confluence
----------------------------------------------------------------------
diff --git a/curator-examples/src/site/confluence/index.confluence b/curator-examples/src/site/confluence/index.confluence
new file mode 100644
index 0000000..e7f3962
--- /dev/null
+++ b/curator-examples/src/site/confluence/index.confluence
@@ -0,0 +1,11 @@
+h1. Examples
+
+This module contains example usages of various Curator features. Each directory in the module is a separate example.
+
+|/leader|Example leader selector code|
+|/cache|Example PathChildrenCache usage|
+|/locking|Example of using InterProcessMutex|
+|/discovery|Example usage of the Curator's ServiceDiscovery|
+|/framework|A few examples of how to use the CuratorFramework class|
+
+TBD - point to the source repo for examples
http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/e6e59866/curator-examples/src/site/resources/css/site.css
----------------------------------------------------------------------
diff --git a/curator-examples/src/site/resources/css/site.css b/curator-examples/src/site/resources/css/site.css
new file mode 100644
index 0000000..f847d66
--- /dev/null
+++ b/curator-examples/src/site/resources/css/site.css
@@ -0,0 +1,4 @@
+tt
+{
+ background-color: transparent;
+}
http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/e6e59866/curator-examples/src/site/site.xml
----------------------------------------------------------------------
diff --git a/curator-examples/src/site/site.xml b/curator-examples/src/site/site.xml
new file mode 100644
index 0000000..380f43f
--- /dev/null
+++ b/curator-examples/src/site/site.xml
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?><!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~ with the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+
+<project xmlns="http://maven.apache.org/DECORATION/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.1.0 http://maven.apache.org/xsd/decoration-1.1.0.xsd" name="Apache Curator Examples">
+ <body>
+ <breadcrumbs>
+ <item name="Home" href="../index.html"/>
+ <item name="Examples" href="index.html"/>
+ </breadcrumbs>
+ </body>
+</project>
http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/e6e59866/src/site/confluence/getting-started.confluence
----------------------------------------------------------------------
diff --git a/src/site/confluence/getting-started.confluence b/src/site/confluence/getting-started.confluence
index bcfdf40..f957de4 100644
--- a/src/site/confluence/getting-started.confluence
+++ b/src/site/confluence/getting-started.confluence
@@ -86,7 +86,3 @@ LeaderSelector selector = new LeaderSelector(client, path, listener);
selector.autoRequeue(); // not required, but this is behavior that you will probably expect
selector.start();
{code}
-
-h2. Examples
-
-Examples of Curator usage can be found here: [[https://github.com/Netflix/curator/tree/master/curator-examples/src/main/java]]
http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/e6e59866/src/site/confluence/index.confluence
----------------------------------------------------------------------
diff --git a/src/site/confluence/index.confluence b/src/site/confluence/index.confluence
index 5a8e7e0..d420ac6 100644
--- a/src/site/confluence/index.confluence
+++ b/src/site/confluence/index.confluence
@@ -29,5 +29,6 @@ most users, the only artifact you need is {{curator-recipes}}.
|org.apache.curator|curator-framework|The Curator Framework high level API. This is built on top of the client and should pull it in automatically.|
|org.apache.curator|curator-client|The Curator Client - replacement for the ZooKeeper class in the ZK distribution.|
|org.apache.curator|curator-test|Contains the TestingServer, the TestingCluster and a few other tools useful for testing.|
+|org.apache.curator|curator-examples|Example usages of various Curator features.|
|org.apache.curator|curator-x-discovery|A Service Discovery implementation built on the Curator Framework.|
|org.apache.curator|curator-x-discovery-server|A RESTful server that can be used with Curator Discovery.|
http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/e6e59866/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
index a388c3a..108e68d 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -48,6 +48,7 @@
<menu name="Apache Curator" inherit="top">
<item name="About" href="index.html"/>
<item name="Getting Started" href="getting-started.html"/>
+ <item name="Examples" href="curator-examples/index.html"/>
<item name="Recipes" href="curator-recipes/index.html"/>
<item name="Framework" href="curator-framework/index.html"/>
<item name="Utilities" href="utilities.html"/>