curator-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From randg...@apache.org
Subject [30/52] [abbrv] git commit: Added mentors
Date Wed, 27 Mar 2013 01:11:25 GMT
Added mentors


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

Branch: refs/heads/master
Commit: eaf47cf0beaf0012088e74bc6477eec42aa109cc
Parents: 6256c0d
Author: Jordan Zimmerman <jordan@jordanzimmerman.com>
Authored: Sun Mar 10 14:42:15 2013 -0700
Committer: Jordan Zimmerman <jordan@jordanzimmerman.com>
Committed: Sun Mar 10 14:42:15 2013 -0700

----------------------------------------------------------------------
 pom.xml                                |   43 +++++++++++++++++++++++++++
 src/site/confluence/history.confluence |   27 +++++++++++++++++
 src/site/confluence/patches.confluence |   37 +++++++++++++++++++++++
 src/site/site.xml                      |    5 +++
 4 files changed, 112 insertions(+), 0 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/eaf47cf0/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 241f976..1b12e29 100644
--- a/pom.xml
+++ b/pom.xml
@@ -56,6 +56,49 @@
         </site>
     </distributionManagement>
 
+    <contributors>
+        <contributor>
+            <name>Patrick Hunt</name>
+            <email>phunt1@gmail.com</email>
+            <roles>
+                <role>Champion</role>
+                <role>Mentor</role>
+            </roles>
+            <timezone>-8</timezone>
+            <url>http://www.linkedin.com/pub/patrick-hunt/2/5b2/24a</url>
+        </contributor>
+
+        <contributor>
+            <name>Mahadev Konar</name>
+            <email>mahadev@apache.org</email>
+            <roles>
+                <role>Mentor</role>
+            </roles>
+            <timezone>-8</timezone>
+            <url>http://www.linkedin.com/in/mahadevkonar</url>
+        </contributor>
+
+        <contributor>
+            <name>Luciano Resende</name>
+            <email>lresende@apache.org</email>
+            <roles>
+                <role>Mentor</role>
+            </roles>
+            <timezone>-8</timezone>
+            <url>https://people.apache.org/~lresende</url>
+        </contributor>
+
+        <contributor>
+            <name>Enis Söztutar</name>
+            <email>enis@apache.org</email>
+            <roles>
+                <role>Mentor</role>
+            </roles>
+            <timezone>-8</timezone>
+            <url>https://people.apache.org/~enis</url>
+        </contributor>
+    </contributors>
+
     <developers>
         <developer>
             <id>randgalt</id>

http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/eaf47cf0/src/site/confluence/history.confluence
----------------------------------------------------------------------
diff --git a/src/site/confluence/history.confluence b/src/site/confluence/history.confluence
new file mode 100644
index 0000000..8ac3ed4
--- /dev/null
+++ b/src/site/confluence/history.confluence
@@ -0,0 +1,27 @@
+h1. Curator's History
+
+Curator was initially developed by [[Jordan Zimmerman|https://people.apache.org/~randgalt]]
at [[Netflix|http://netflix.github.com]] to
+make writing ZooKeeper-based applications easier and more reliable. Curator was open-sourced
by Netflix on GitHub as an Apache 2.0 licensed project in
+July 2011. During this time Curator has been formally released many times and has gained
widespread adoption.
+
+The [[Curator Incubator Proposal|http://wiki.apache.org/incubator/CuratorProposal]] was presented
in February 2013 and was formally accepted into the Incubator
+in March 2013.
+
+h2. Rationale
+
+New users of ZooKeeper are surprised to learn that a significant amount of connection management
must
+be done manually. For example, when the ZooKeeper client connects to the ensemble it must
negotiate a new session,
+etc. This takes some time. If you use a ZooKeeper client API before the connection process
has completed, ZooKeeper
+will throw an exception. These types of exceptions are referred to as "recoverable" errors.
Curator automatically
+handles connection management, greatly simplifying client code. Instead of directly using
the ZooKeeper APIs you
+use Curator APIs that internally check for connection completion and wrap each ZooKeeper
API in a retry loop.
+Curator uses a retry mechanism to handle recoverable errors and automatically retry operations.
The method of retry
+is customizable. Curator comes bundled with several implementations (ExponentialBackoffRetry,
etc.) or custom implementations can be written.
+
+The ZooKeeper documentation describes many possible uses for ZooKeeper calling each a "recipe".
While the distribution
+comes bundled with a few implementations of these recipes, most ZooKeeper users will need
to manually implement one
+or more of the recipes. Implementing a ZooKeeper recipe is not trivial. Besides the connection
handling issues, there
+are numerous edge cases that are not well documented that must be considered. For example,
many recipes require that an
+ephemeral-sequential node be created. New users of ZooKeeper will not know that there is
an edge case in ephemeral-sequential
+node creation that requires you to put a special "marker" in the node’s name so that you
can search for the created node if an
+I/O failure occurs. This is but one of many edge cases that are not well documented but are
handled by Curator.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/eaf47cf0/src/site/confluence/patches.confluence
----------------------------------------------------------------------
diff --git a/src/site/confluence/patches.confluence b/src/site/confluence/patches.confluence
new file mode 100644
index 0000000..552d618
--- /dev/null
+++ b/src/site/confluence/patches.confluence
@@ -0,0 +1,37 @@
+h1. Submitting Patches
+
+h2. Apache Contribution Guide
+Please read the [[Apache Contribution Guide|http://www.apache.org/foundation/getinvolved.html]].
+
+h2. Tools/Libraries
+Curator uses:
+
+* Maven
+* Jira
+* TestNG
+* SLF4J
+* Google Guava
+
+h2. Style/Development Guide
+* Use spaces not tabs
+* Match the style of the Curator files. Any patches will be re-formatted to match Curator
style
+* All submissions must have TestNG tests
+* All submissions must have proper Apache license headers
+* The simpler and smaller the change the more likely it is to be accepted
+
+h2. Creating A Patch
+The Apache Curator source code repository holds the current source. A link to information
about using the
+Apache Curator source code repository is available on the main Apache Curator page. Apache
Curator
+uses the Git version control system.
+
+You must create an issue in the [[Curator's Issue Tracker|https://issues.apache.org/jira/browse/CURATOR]].
+Create your patch against the latest revision of the files in the source code repository.
Use Git to create the patch:
+
+{noformat}
+git diff [options] > [filename]
+{noformat}
+
+The patch filename should match the Issue Number. i.e. if the Issue Number is _CURATOR-101_
the patch filename should be
+_CURATOR-101.patch_. Attach the patch file to the Issue.
+
+All discussion, comments, etc. regarding the patch should be in the Issue Tracker and not
by email.

http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/eaf47cf0/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
index abefa2f..f54e287 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -69,6 +69,11 @@
             <item name="Service Discovery Server" href="curator-x-discovery-server/index.html"/>
         </menu>
 
+        <menu name="Community" inherit="top">
+            <item name="Submitting Patches" href="patches.html"/>
+            <item name="History" href="history.html"/>
+        </menu>
+
         <menu name="ASF" inherit="bottom">
             <item name="How the ASF works" href="http://www.apache.org/foundation/how-it-works.html"/>
             <item name="Get Involved" href="http://www.apache.org/foundation/getinvolved.html"/>


Mime
View raw message