accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ctubb...@apache.org
Subject [3/6] accumulo git commit: ACCUMULO-4454 Auto-determine version for manual
Date Thu, 29 Sep 2016 20:01:01 GMT
ACCUMULO-4454 Auto-determine version for manual

Use resource filtering to generate the Accumulo version placed in the
user manual. Also fix some minor broken links and old LaTeX syntax found
while testing.


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

Branch: refs/heads/master
Commit: 52f53f56e32c10f81017205842f134736dfa9759
Parents: 31590b8
Author: Christopher Tubbs <ctubbsii@apache.org>
Authored: Thu Sep 29 15:27:49 2016 -0400
Committer: Christopher Tubbs <ctubbsii@apache.org>
Committed: Thu Sep 29 15:27:49 2016 -0400

----------------------------------------------------------------------
 docs/pom.xml                                         |  6 ++++++
 docs/src/main/asciidoc/accumulo_user_manual.asciidoc |  6 +++---
 docs/src/main/asciidoc/chapters/administration.txt   |  4 ++--
 docs/src/main/asciidoc/chapters/clients.txt          |  2 +-
 docs/src/main/asciidoc/chapters/kerberos.txt         |  2 +-
 docs/src/main/resources/examples/README              |  2 +-
 pom.xml                                              | 12 ++++++++++++
 7 files changed, 26 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo/blob/52f53f56/docs/pom.xml
----------------------------------------------------------------------
diff --git a/docs/pom.xml b/docs/pom.xml
index 9c5a333..198d623 100644
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -47,9 +47,15 @@
             <phase>compile</phase>
             <configuration>
               <outputDirectory>${project.build.directory}/asciidoc</outputDirectory>
+              <escapeString>\</escapeString>
+              <useDefaultDelimiters>false</useDefaultDelimiters>
+              <delimiters>
+                <delimiter>${*}</delimiter>
+              </delimiters>
               <resources>
                 <resource>
                   <directory>src/main/asciidoc</directory>
+                  <filtering>true</filtering>
                 </resource>
               </resources>
             </configuration>

http://git-wip-us.apache.org/repos/asf/accumulo/blob/52f53f56/docs/src/main/asciidoc/accumulo_user_manual.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/main/asciidoc/accumulo_user_manual.asciidoc b/docs/src/main/asciidoc/accumulo_user_manual.asciidoc
index 4bb87cd..0f9ad0c 100644
--- a/docs/src/main/asciidoc/accumulo_user_manual.asciidoc
+++ b/docs/src/main/asciidoc/accumulo_user_manual.asciidoc
@@ -13,15 +13,15 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-Apache Accumulo User Manual Version 1.7
+Apache Accumulo® User Manual Version ${parsedVersion.majorVersion}.${parsedVersion.minorVersion}
 =======================================
 :author: Apache Accumulo Project
 :email: dev@accumulo.apache.org
 :toc2:
 :toclevels: 4
-:toc-title: Apache Accumulo 1.7
+:toc-title: Apache Accumulo ${parsedVersion.majorVersion}.${parsedVersion.minorVersion}
 :numbered:
-:website: http://accumulo.apache.org/
+:website: https://accumulo.apache.org/
 
 image::accumulo-logo.png[]
 

http://git-wip-us.apache.org/repos/asf/accumulo/blob/52f53f56/docs/src/main/asciidoc/chapters/administration.txt
----------------------------------------------------------------------
diff --git a/docs/src/main/asciidoc/chapters/administration.txt b/docs/src/main/asciidoc/chapters/administration.txt
index de8920a..54cc1e1 100644
--- a/docs/src/main/asciidoc/chapters/administration.txt
+++ b/docs/src/main/asciidoc/chapters/administration.txt
@@ -286,7 +286,7 @@ when the Configuration object for accumulo-site.xml is accessed.
 
 One of the implementations provided in Hadoop-2.6.0 is a Java KeyStore CredentialProvider.
 Each entry in the KeyStore is the Accumulo Property key name. For example, to store the
-\texttt{instance.secret}, the following command can be used:
+`instance.secret`, the following command can be used:
 
   hadoop credential create instance.secret --provider jceks://file/etc/accumulo/conf/accumulo.jceks
 
@@ -323,7 +323,7 @@ The client configuration file is a subset of the information stored in
accumulo-
 meant only for consumption by clients of Accumulo. By default, Accumulo checks a number
 of locations for a client configuration by default:
 
-* +${ACCUMULO_CONF_DIR}/client.conf+
+* +\${ACCUMULO_CONF_DIR}/client.conf+
 * +/etc/accumulo/client.conf+
 * +/etc/accumulo/conf/client.conf+
 * +~/.accumulo/config+

http://git-wip-us.apache.org/repos/asf/accumulo/blob/52f53f56/docs/src/main/asciidoc/chapters/clients.txt
----------------------------------------------------------------------
diff --git a/docs/src/main/asciidoc/chapters/clients.txt b/docs/src/main/asciidoc/chapters/clients.txt
index 53abd03..d142d66 100644
--- a/docs/src/main/asciidoc/chapters/clients.txt
+++ b/docs/src/main/asciidoc/chapters/clients.txt
@@ -57,7 +57,7 @@ Instance inst = new ZooKeeperInstance(instanceName, zooServers);
 Connector conn = inst.getConnector("user", new PasswordToken("passwd"));
 ----
 
-The PasswordToken is the most common implementation of an \texttt{AuthenticationToken}.
+The PasswordToken is the most common implementation of an `AuthenticationToken`.
 This general interface allow authentication as an Accumulo user to come from
 a variety of sources or means. The CredentialProviderToken leverages the Hadoop
 CredentialProviders (new in Hadoop 2.6).

http://git-wip-us.apache.org/repos/asf/accumulo/blob/52f53f56/docs/src/main/asciidoc/chapters/kerberos.txt
----------------------------------------------------------------------
diff --git a/docs/src/main/asciidoc/chapters/kerberos.txt b/docs/src/main/asciidoc/chapters/kerberos.txt
index fec9277..a165221 100644
--- a/docs/src/main/asciidoc/chapters/kerberos.txt
+++ b/docs/src/main/asciidoc/chapters/kerberos.txt
@@ -559,4 +559,4 @@ on, is extremely important when negotiating an SASL connection. This problem
com
 servers are not configured to listen on the address denoted by their FQDN.
 
 The values in the Accumulo "hosts" files (In +$ACCUMULO_CONF_DIR+: +masters+, +monitors+,
+slaves+, +tracers+,
-and +gc+) should match the instance componentof the Kerberos server principal (e.g. +host+
in +accumulo/host\@EXAMPLE.COM+).
+and +gc+) should match the instance componentof the Kerberos server principal (e.g. +host+
in +accumulo/host@EXAMPLE.COM+).

http://git-wip-us.apache.org/repos/asf/accumulo/blob/52f53f56/docs/src/main/resources/examples/README
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/examples/README b/docs/src/main/resources/examples/README
index 4211050..406f362 100644
--- a/docs/src/main/resources/examples/README
+++ b/docs/src/main/resources/examples/README
@@ -92,4 +92,4 @@ features of Apache Accumulo.
                        Also shows user permissions.
 
 
-[1]: /1.5/user_manual/Accumulo_Shell.html#User_Administration
+[1]: https://accumulo.apache.org/1.5/accumulo_user_manual#_user_administration

http://git-wip-us.apache.org/repos/asf/accumulo/blob/52f53f56/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 62f58bb..f7b57cf 100644
--- a/pom.xml
+++ b/pom.xml
@@ -827,6 +827,18 @@
     </pluginManagement>
     <plugins>
       <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>build-helper-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>parse-project-version</id>
+            <goals>
+              <goal>parse-version</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
         <!-- verify before compile; should be sorted already -->
         <groupId>com.github.ekryd.sortpom</groupId>
         <artifactId>sortpom-maven-plugin</artifactId>


Mime
View raw message