accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [1/3] accumulo-website git commit: Several updates to documentation
Date Mon, 03 Jul 2017 12:53:36 GMT
Repository: accumulo-website
Updated Branches:
  refs/heads/asf-site 78bb2bce1 -> cfab25205
  refs/heads/master 0b26f09c5 -> 74699ed77


Several updates to documentation

* Accumulo version is now dynamically set
* Improved documentation on creating Accumulo clients
* Included documentation on how to add Accumulo dep to Maven pom


Project: http://git-wip-us.apache.org/repos/asf/accumulo-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo-website/commit/ba7d7723
Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/ba7d7723
Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/ba7d7723

Branch: refs/heads/master
Commit: ba7d7723219b3e6502ca8e74b9b07af0ae24903d
Parents: 2b8bf45
Author: Mike Walch <mwalch@apache.org>
Authored: Fri Jun 30 17:12:54 2017 -0400
Committer: Mike Walch <mwalch@apache.org>
Committed: Fri Jun 30 17:12:54 2017 -0400

----------------------------------------------------------------------
 _config.yml                                     |  2 +-
 .../administration/in-depth-install.md          |  4 +--
 _docs-unreleased/getting-started/clients.md     | 34 ++++++++++++++++----
 .../getting-started/quick-install.md            |  6 ++--
 _docs-unreleased/getting-started/shell.md       |  2 +-
 5 files changed, 34 insertions(+), 14 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/ba7d7723/_config.yml
----------------------------------------------------------------------
diff --git a/_config.yml b/_config.yml
index d338ab0..2df7621 100644
--- a/_config.yml
+++ b/_config.yml
@@ -59,7 +59,7 @@ defaults:
       layout: "docs-unreleased"
       title_prefix: "Accumulo Documentation - "
       version: "unreleased"
-      latest_release: "1.8.1"
+      latest_release: "2.0.0"
       docs_baseurl: "/docs/unreleased"
       javadoc_base: "https://static.javadoc.io/org.apache.accumulo"
       javadoc_core: "https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1"

http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/ba7d7723/_docs-unreleased/administration/in-depth-install.md
----------------------------------------------------------------------
diff --git a/_docs-unreleased/administration/in-depth-install.md b/_docs-unreleased/administration/in-depth-install.md
index 8719036..532fcc3 100644
--- a/_docs-unreleased/administration/in-depth-install.md
+++ b/_docs-unreleased/administration/in-depth-install.md
@@ -62,8 +62,8 @@ Download a binary distribution of Accumulo and install it to a directory
on a di
 sufficient space:
 
     cd <install directory>
-    tar xzf accumulo-X.Y.Z-bin.tar.gz   # Replace 'X.Y.Z' with your Accumulo version
-    cd accumulo-X.Y.Z
+    tar xzf accumulo-{{ page.latest_release }}-bin.tar.gz
+    cd accumulo-{{ page.latest_release }}
 
 Repeat this step on each machine in your cluster. Typically, the same `<install directory>`
 is chosen for all machines in the cluster.

http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/ba7d7723/_docs-unreleased/getting-started/clients.md
----------------------------------------------------------------------
diff --git a/_docs-unreleased/getting-started/clients.md b/_docs-unreleased/getting-started/clients.md
index 8596c2e..20a57b5 100644
--- a/_docs-unreleased/getting-started/clients.md
+++ b/_docs-unreleased/getting-started/clients.md
@@ -4,16 +4,36 @@ category: getting-started
 order: 3
 ---
 
+## Creating Client Code
+
+If you are using Maven to create Accumulo client code, add the following to your pom:
+
+```xml
+<dependency>
+  <groupId>org.apache.accumulo</groupId>
+  <artifactId>accumulo-core</artifactId>
+  <version>{{ page.latest_release }}</version>
+</dependency>
+```
+
 ## Running Client Code
 
-There are multiple ways to run Java code that uses Accumulo. Below is a list
+There are multiple ways to run Java code that use Accumulo. Below is a list
 of the different ways to execute client code.
 
-* using the `java` command
-* using the `accumulo` command
-* using the `accumulo-util hadoop-jar` command
+* build and execute an uber jar
+* add `accumulo classpath` to your Java classpath
+* use the `accumulo` command
+* use the `accumulo-util hadoop-jar` command
+
+### Build and execute an uber jar
+
+If you have included `accumulo-core` as dependency in your pom, you can build an uber jar
+using the Maven assembly or shade plugin and use it to run Accumulo client code. When building
+an uber jar, you should set the versions of any Hadoop dependencies in your pom to match
the
+version running on your cluster.
 
-### Using the java command
+### Add 'accumulo classpath' to your Java classpath
 
 To run Accumulo client code using the `java` command, use the `accumulo classpath` command

 to include all of Accumulo's dependencies on your classpath:
@@ -25,7 +45,7 @@ output a more human readable format using the `-d` option which enables
debuggin
 
     accumulo classpath -d
 
-### Using the accumulo command
+### Use the accumulo command
 
 Another option for running your code is to use the Accumulo script which can execute a
 main class (if it exists on its classpath):
@@ -40,7 +60,7 @@ the accumulo command.
 
     export CLASSPATH=/path/to/my.jar:/path/to/dep.jar; accumulo com.foo.Client arg1 arg2
 
-### Using the 'accumulo-util hadoop-jar' command
+### Use the 'accumulo-util hadoop-jar' command
 
 If you are writing map reduce job that accesses Accumulo, then you can use
 `accumulo-util hadoop-jar` to run those jobs. See the [MapReduce example][mapred-example]

http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/ba7d7723/_docs-unreleased/getting-started/quick-install.md
----------------------------------------------------------------------
diff --git a/_docs-unreleased/getting-started/quick-install.md b/_docs-unreleased/getting-started/quick-install.md
index 07a15d6..8346bb5 100644
--- a/_docs-unreleased/getting-started/quick-install.md
+++ b/_docs-unreleased/getting-started/quick-install.md
@@ -12,8 +12,8 @@ see the [in-depth installation guide][in-depth].
 Either [download] or [build] a binary distribution of Accumulo from source code and
 unpack as follows.
 
-    tar xzf /path/to/accumulo-X.Y.Z-bin.tar.gz
-    cd accumulo-X.Y.Z
+    tar xzf /path/to/accumulo-{{ page.latest_release}}-bin.tar.gz
+    cd accumulo-{{ page.latest_release }}
 
 There are four scripts in the `bin` directory of the tarball distribution that are used
 to manage Accumulo:
@@ -24,7 +24,7 @@ to manage Accumulo:
 4. `accumulo-util` - Accumulo utilities for building native libraries, running jars, etc.
 
 These scripts will be used in the remaining instructions to configure and run Accumulo.
-For convenience, consider adding `accumulo-X.Y.Z/bin/` to your shell's path.
+For convenience, consider adding `accumulo-{{ page.latest_release }}/bin/` to your shell's
path.
 
 ## Configuring Accumulo
 

http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/ba7d7723/_docs-unreleased/getting-started/shell.md
----------------------------------------------------------------------
diff --git a/_docs-unreleased/getting-started/shell.md b/_docs-unreleased/getting-started/shell.md
index 316a060..7796d10 100644
--- a/_docs-unreleased/getting-started/shell.md
+++ b/_docs-unreleased/getting-started/shell.md
@@ -17,7 +17,7 @@ and then display the following prompt:
 
     Shell - Apache Accumulo Interactive Shell
     -
-    - version: 2.x.x
+    - version: {{ page.latest_release }}
     - instance name: myinstance
     - instance id: 00000000-0000-0000-0000-000000000000
     -


Mime
View raw message