You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by sm...@apache.org on 2015/02/16 05:44:29 UTC
directory-fortress-core git commit: FC-66 - final doc cleanup
Repository: directory-fortress-core
Updated Branches:
refs/heads/master 32c007cf7 -> 9162a533d
FC-66 - final doc cleanup
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/9162a533
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/9162a533
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/9162a533
Branch: refs/heads/master
Commit: 9162a533d43ac2b0bf6a5c0899180c8af959732b
Parents: 32c007c
Author: Shawn McKinney <sm...@apache.org>
Authored: Sun Feb 15 22:44:13 2015 -0600
Committer: Shawn McKinney <sm...@apache.org>
Committed: Sun Feb 15 22:44:13 2015 -0600
----------------------------------------------------------------------
README-TEN-MINUTE-GUIDE.txt | 10 ++++----
.../core/doc-files/apache-fortress-core.html | 27 +++++---------------
.../core/doc-files/apache-fortress-realm.html | 24 +++--------------
.../core/doc-files/apache-fortress-rest.html | 27 +++++---------------
.../core/doc-files/apache-fortress-web.html | 27 +++++---------------
.../core/doc-files/ten-minute-guide.html | 8 +++---
6 files changed, 31 insertions(+), 92 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/9162a533/README-TEN-MINUTE-GUIDE.txt
----------------------------------------------------------------------
diff --git a/README-TEN-MINUTE-GUIDE.txt b/README-TEN-MINUTE-GUIDE.txt
index db25975..cd5e6e2 100644
--- a/README-TEN-MINUTE-GUIDE.txt
+++ b/README-TEN-MINUTE-GUIDE.txt
@@ -20,7 +20,7 @@ ________________________________________________________________________________
###################################################################################
# README for Fortress Ten Minute Guide
# Version 1.0-RC40
-# last updated: February 10, 2015
+# last updated: February 15, 2015
###################################################################################
___________________________________________________________________________________
###################################################################################
@@ -32,7 +32,7 @@ ________________________________________________________________________________
3. Git installed to target machine.
-4. Java SDK Version 7 or beyond installed to target machine.
+4. Java SDK Version 7 (or beyond) sdk installed to target machine.
5. Apache Maven 3 installed to target machine.
@@ -48,7 +48,7 @@ All other packages will be covered inside the tutorial.
2. Change directory to package home:
# cd directory-fortress-core/
-3. Set JAVA_HOME & M2_HOME
+3. Set java and maven home env variables.
4. Build the Fortress Core source:
# mvn clean install -DskipTests
@@ -57,9 +57,9 @@ All other packages will be covered inside the tutorial.
# mvn javadoc:javadoc
6. Point your web browser to the following location:
- file:///[package home]/target/site/apidocs/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
+ file:///[directory-fortress-core]/target/site/apidocs/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
- (where [package_home] is location of directory-fortress-core base package)
+ (where [directory-fortress-core] is location of current source package)
7. Follow the steps under 'Navigation Links':
a. Setup Apache Directory Server
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/9162a533/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
index 1344335..12b6ca0 100755
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
@@ -56,15 +56,9 @@
</li>
- <li>
- Set JAVA_HOME:
- <pre>
- <p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# export JAVA_HOME=/opt/jdk1.7.0_10/
- </p>
- </pre>
+ <li>Set java and maven home env variables.</li>
- </li>
+ <br>
<li>
Change directory:
@@ -76,15 +70,6 @@
</li>
<li>
- Set M2_HOME:
- <pre>
- <p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# export M2_HOME=/usr/local/maven-version
- </p>
- </pre>
- </li>
-
- <li>
Edit the build.properties in root folder of package.
These parameters are bound for files like <b>config/fortress.properties</b> and <b>ldap/setup/refreshLDAPData.xml</b>
and used on subsequent steps.
@@ -108,7 +93,7 @@ ldap.server.type=apacheds
is dependent on fortress core.
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn clean install -DskipTests
+# mvn clean install -DskipTests
</p>
</pre>
</li>
@@ -173,7 +158,7 @@ ldap.server.type=apacheds
Build the fortress LDAP DIT and create the configuration node:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn install -Dload.file=./ldap/setup/refreshLDAPData.xml -DskipTests
+# mvn install -Dload.file=./ldap/setup/refreshLDAPData.xml -DskipTests
</p>
</pre>
</li>
@@ -182,7 +167,7 @@ ldap.server.type=apacheds
Load the fortress ARBAC policies:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn install -Dload.file=./ldap/setup/DelegatedAdminManagerLoad.xml -DskipTests
+# mvn install -Dload.file=./ldap/setup/DelegatedAdminManagerLoad.xml -DskipTests
</p>
</pre>
</li>
@@ -191,7 +176,7 @@ ldap.server.type=apacheds
Run the Fortress Core Regression Tess:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn -Dtest=FortressJUnitTest test
+# mvn -Dtest=FortressJUnitTest test
</p>
</pre>
Tests should run with no errors.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/9162a533/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-realm.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-realm.html b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-realm.html
index ac610ae..ce29c6e 100644
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-realm.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-realm.html
@@ -57,14 +57,9 @@
</li>
- <li>
- Set JAVA_HOME:
- <pre>
- <p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# export JAVA_HOME=/opt/jdk1.7.0_10/
- </p>
- </pre>
- </li>
+ <li>Set java and maven home env variables.</li>
+
+ <br>
<li>
Change directory:
@@ -76,24 +71,13 @@
</li>
<li>
- Set M2_HOME:
- <pre>
- <p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# export M2_HOME=/usr/local/maven-version
- </p>
- </pre>
- </li>
-
- <br>
-
- <li>
Build fortress realm with maven and install to local repo. The fortress rest [<a
href="apache-fortress-rest.html">Build Apache Fortress Rest</a>]
and fortress web [<a href="apache-fortress-web.html">Build Apache Fortress Web</a>]
are both dependent on the fortress realm.
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn clean install
+# mvn clean install
</p>
</pre>
</li>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/9162a533/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
index 29e409d..d4a077a 100755
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
@@ -58,15 +58,9 @@
</li>
- <li>
- Set JAVA_HOME:
- <pre>
- <p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# export JAVA_HOME=/opt/jdk1.7.0_10/
- </p>
- </pre>
+ <li>Set java and maven home env variables.</li>
- </li>
+ <br>
<li>
Change directory:
@@ -78,19 +72,10 @@
</li>
<li>
- Set M2_HOME:
- <pre>
- <p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# export M2_HOME=/usr/share/maven-version
- </p>
- </pre>
- </li>
-
- <li>
Generate the javadoc
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn javadoc:javadoc
+# mvn javadoc:javadoc
</p>
</pre>
The javadoc will be located under target/site/apidocs.
@@ -116,7 +101,7 @@
To deploy fortress rest, run this command:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn tomcat:deploy
+# mvn tomcat:deploy
</p>
</pre>
</li>
@@ -125,7 +110,7 @@
To redeploy:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn tomcat:redeploy
+# mvn tomcat:redeploy
</p>
</pre>
</li>
@@ -134,7 +119,7 @@
Run the tests:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn verify -Dnoload
+# mvn verify -Dnoload
</p>
</pre>
</li>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/9162a533/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-web.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-web.html b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-web.html
index fea5ec5..a8ca9e3 100755
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-web.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-web.html
@@ -56,15 +56,9 @@
</li>
- <li>
- Set JAVA_HOME:
- <pre>
- <p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# export JAVA_HOME=/opt/jdk1.7.0_10/
- </p>
- </pre>
+ <li>Set java and maven home env variables.</li>
- </li>
+ <br>
<li>
Change directory:
@@ -76,15 +70,6 @@
</li>
<li>
- Set M2_HOME:
- <pre>
- <p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# export M2_HOME=/usr/share/maven-version
- </p>
- </pre>
- </li>
-
- <li>
Copy the fortress.properties, created on step <a href="./apache-fortress-core.html">Build Apache Fortress Core</a>, to this package's resource folder.
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
@@ -100,7 +85,7 @@
To deploy fortress web, run this command:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn tomcat:deploy
+# mvn tomcat:deploy
</p>
</pre>
</li>
@@ -109,7 +94,7 @@
To redeploy:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn tomcat:redeploy
+# mvn tomcat:redeploy
</p>
</pre>
</li>
@@ -144,11 +129,13 @@
</ol>
</li>
+ <br>
+
<li>
Run the Selenium Web driver integration tests:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn verify -DskipTests=false -Dnoload
+# mvn verify -DskipTests=false -Dnoload
</p>
</pre>
</li>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/9162a533/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html b/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
index 4f3dd05..02c757b 100644
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
@@ -50,7 +50,7 @@
These items are required and must be installed to target machine before any of these tutorial steps. Instructions cover Debian and Fedora system syntax.
Fortress is Java, runs on various platforms, but the others are not be covered here.
<ol type="1">
- <li>Java 7 (or greater) for both compilation (jdk) and runtime (jre) required for every software package covered by this tutorial.</li>
+ <li>Java 7 (or greater) sdk installed.</li>
<li><a href="http://git-scm.com/download/linux">Git Download for Linux and Unix</a></li>
<li><a href="http://maven.apache.org/">Apache Maven 3</a></li>
<li><a href="https://www.mozilla.org/en-GB/firefox/new/">Firefox Web Browser</a></li>
@@ -77,14 +77,12 @@ This tutorial is contained within the javadoc of directory-fortress-core source
Where [directory-fortress-core] is base folder of the fortress core source package.
</li>
<br>
- <li>Set JAVA_HOME</li>
- <br>
- <li>Set M2_HOME</li>
+ <li>Set java and maven home env variables.</li>
<br>
<li>Build the javadoc which contains the tutorial:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn javadoc:javadoc
+# mvn javadoc:javadoc
</p>
</pre>
</li>