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 2017/07/23 02:41:22 UTC
[14/23] curator git commit: more doc tweaks
more doc tweaks
Project: http://git-wip-us.apache.org/repos/asf/curator/repo
Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/0906eb53
Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/0906eb53
Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/0906eb53
Branch: refs/heads/master
Commit: 0906eb539d6b5aa3ad65bf7413f5c955288758b8
Parents: 46ce6b7
Author: randgalt <ra...@apache.org>
Authored: Fri Jul 21 14:24:56 2017 -0500
Committer: randgalt <ra...@apache.org>
Committed: Fri Jul 21 14:24:56 2017 -0500
----------------------------------------------------------------------
src/site/confluence/compatibility.confluence | 53 ++++++++++++++++++++---
src/site/site.xml | 2 +-
2 files changed, 47 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/curator/blob/0906eb53/src/site/confluence/compatibility.confluence
----------------------------------------------------------------------
diff --git a/src/site/confluence/compatibility.confluence b/src/site/confluence/compatibility.confluence
index ef3324f..4103bf2 100644
--- a/src/site/confluence/compatibility.confluence
+++ b/src/site/confluence/compatibility.confluence
@@ -1,9 +1,48 @@
-h1. API Compatibility
+h1. ZooKeeper Version Compatibility
-A [[Clirr|http://clirr.sourceforge.net/]] report is generated for each Curator module:
+While ZooKeeper 3.5.x is still considered "beta" by the ZooKeeper development team, the reality is that it is
+used in production by many users. However, ZooKeeper 3.4.x is also used in production. Prior to Apache Curator
+4.0, both versions of ZooKeeper were supported via two versions of Apache Curator. Starting with Curator 4.0
+both versions of ZooKeeper are supported via the same Curator libraries.
+
+h2. ZooKeeper 3.5.x
+
+* Curator 4.0 has a hard dependency on ZooKeeper 3.5.x
+* If you are using ZooKeeper 3.5.x there's nothing additional to do \- just use Curator 4.0
+
+h2. ZooKeeper 3.4.x
+
+Curator 4.0 supports ZooKeeper 3.4.x ensembles in a soft\-compatibility mode. To use this mode
+you must exclude ZooKeeper when adding Curator to your dependency management tool.
+
+_Maven_
+
+{code}
+<dependency>
+ <groupId>org.apache.curator</groupId>
+ <artifactId>curator-recipes</artifactId>
+ <version>${curator-version}</version>
+ <exclusions>
+ <exclusion>
+ <groupId>org.apache.zookeeper</groupId>
+ <artifactId>zookeeper</artifactId>
+ </exclusion>
+ </exclusions>
+</dependency>
+{code}
+
+_Gradle_
+
+{code}
+compile('org.apache.curator:curator-recipes:$curatorVersion') {
+ exclude('org.apache.zookeeper:zookeeper')
+}
+{code}
+
+You must add a dependency on ZooKeeper 3.4.x also.
+
+Curator will detect which ZooKeeper library is in use and automatically set ZooKeeper 3.4 compatibility
+mode as needed. In this mode, all features not supported by 3.4 are disabled. It is up to your
+application code to "do the right thing" and not use these features. Use the {{isZk34CompatibilityMode()}}
+method to determine which mode Curator is using at runtime.
-* [[Curator Client Report|curator-client/clirr-report.html]]
-* [[Curator Framework Report|curator-framework/clirr-report.html]]
-* [[Curator Recipes Report|curator-recipes/clirr-report.html]]
-* [[Curator Discovery Report|curator-x-discovery/clirr-report.html]]
-* [[Curator Discovery Server Report|curator-x-discovery-server/clirr-report.html]]
http://git-wip-us.apache.org/repos/asf/curator/blob/0906eb53/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
index d78b5b7..8bff322 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -39,7 +39,7 @@
<twitter>
<user>ApacheCurator</user>
<showUser>true</showUser>
- <showFollowers>true</showFollowers>
+ <showFollowers>false</showFollowers>
</twitter>
<googleSearch>
<sitesearch>${project.url}</sitesearch>