accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [1/3] accumulo git commit: ACCUMULO-4189 - Added direct links to documentation on Accumulo website
Date Tue, 03 May 2016 23:10:42 GMT
Repository: accumulo
Updated Branches:
  refs/heads/master 4a79d586d -> ce7c1fa5d

ACCUMULO-4189 - Added direct links to documentation on Accumulo website


Branch: refs/heads/master
Commit: b3aad3d964afd557a9ca1b9d2fe49b331ae75b5c
Parents: 25b99c2
Author: Mike Walch <>
Authored: Mon Apr 11 17:24:23 2016 -0400
Committer: Mike Walch <>
Committed: Thu Apr 21 10:38:10 2016 -0400

---------------------------------------------------------------------- | 45 +++++++++++++++++++++++----------------------
 1 file changed, 23 insertions(+), 22 deletions(-)
diff --git a/ b/
index 633e1b5..fbd4bc4 100644
--- a/
+++ b/
@@ -29,32 +29,28 @@ and feature are outlined [here][8].
 To install and run an Accumulo binary distribution, follow the [install][2]
-Accumulo provides the following documentation :
- * **User Manual** : In-depth developer and administrator documentation.
- * **Examples** : Code with corresponding readme files that give step by step
-                  instructions for running example code.
+Accumulo has the following documentation which is viewable on the [Accumulo website][1]
+using the links below:
-This documentation is available on the [Accumulo site][1].  In the source and
-binary distributions of Accumulo, the documentation is at different locations.
+* [User Manual][10] - In-depth developer and administrator documentation.
+* [Examples][11] - Code with corresponding README files that give step by step
+instructions for running the example.
-In the Accumulo binary distribution, all documentation is in the `docs`
-directory.  The binary distribution does not include example source code, but
-it does include a jar with the compiled examples.   This examples jar makes it
-easy to step through the example readmes, after following the [install][2]
+This documentation can also be found in Accumulo distributions:
-In the Accumulo source, documentations is found at the following locations.
+* **Binary distribution** - The User Manual can be found in the `docs` directory.  The
+Examples Readmes can be found in `docs/examples`. While the source for the Examples is
+not included, the distribution has a jar with the compiled examples. This makes it easy
+to run them after following the [install][2] instructions.
- * [Example Source](examples/simple/src/main/java/org/apache/accumulo/examples/simple)
- * [Example Readmes](docs/src/main/resources/examples)
- * [User Manual Source](docs/src/main/asciidoc)
+* **Source distribution** - The [Example Source][14], [Example Readmes][15], and
+[User Manual Source][16] can all be found in the source distribution.
 Accumulo uses [Maven][9] to compile, [test][3], and package its source.  The
@@ -77,7 +73,7 @@ API
 The public Accumulo API is composed of :
 All public types in the following packages and their subpackages excluding
-those named *impl*, *thrift*, or *crypto*. 
+those named *impl*, *thrift*, or *crypto*.
    * org.apache.accumulo.core.client
@@ -91,7 +87,7 @@ the above packages are *not* considered public API.
 The following regex matches imports that are *not* Accumulo public API.  This
 regex can be used with [RegexpSingleline][13] to automatically find suspicious
-imports in a project using Accumulo. 
+imports in a project using Accumulo.
@@ -101,14 +97,19 @@ The Accumulo project maintains binary compatibility across this API within
 major release, as defined in the Java Language Specification 3rd ed. Starting
 with Accumulo 1.6.2 and 1.7.0 all API changes will follow [semver 2.0][12]
+[14]: examples/simple/src/main/java/org/apache/accumulo/examples/simple
+[15]: docs/src/main/resources/examples
+[16]: docs/src/main/asciidoc

View raw message