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/05 01:15:11 UTC
directory-fortress-core git commit: FC-56 - Fix Documentation -
Change name of new quickstart to 'ten minute guide'.
Repository: directory-fortress-core
Updated Branches:
refs/heads/master ea721e82e -> 466d751ad
FC-56 - Fix Documentation - Change name of new quickstart to 'ten minute guide'.
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/466d751a
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/466d751a
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/466d751a
Branch: refs/heads/master
Commit: 466d751add4d74f699793ef778165afb2d26908d
Parents: ea721e8
Author: Shawn McKinney <sm...@apache.org>
Authored: Wed Feb 4 18:14:53 2015 -0600
Committer: Shawn McKinney <sm...@apache.org>
Committed: Wed Feb 4 18:14:53 2015 -0600
----------------------------------------------------------------------
.../core/doc-files/apache-directory.html | 2 +-
.../core/doc-files/apache-fortress-core.html | 8 +-
.../doc-files/apache-fortress-quickstart.html | 81 ---------------
.../core/doc-files/apache-fortress-realm.html | 4 +-
.../core/doc-files/apache-fortress-rest.html | 8 +-
.../core/doc-files/apache-fortress-web.html | 8 +-
.../core/doc-files/ten-minute-guide.html | 104 +++++++++++++++++++
.../directory/fortress/core/overview.html | 12 ++-
8 files changed, 129 insertions(+), 98 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/466d751a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-directory.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-directory.html b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-directory.html
index 28c5da6..c14fb75 100755
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-directory.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-directory.html
@@ -31,7 +31,7 @@
<li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
<li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
</ul>
- <li><a href="./apache-fortress-quickstart.html">Apache Fortress Quickstart</a></li>
+ <li><a href="./ten-minute-guide.html">Ten Minute Guide</a></li>
</fieldset>
<hr>
</head>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/466d751a/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 1d76ff4..3fb966c 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
@@ -31,7 +31,7 @@
<li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
<li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
</ul>
- <li><a href="./apache-fortress-quickstart.html">Apache Fortress Quickstart</a></li>
+ <li><a href="./ten-minute-guide.html">Ten Minute Guide</a></li>
</fieldset>
<hr>
</head>
@@ -39,11 +39,11 @@
<p>
<h3>Build Apache Fortress Core</h3>
<img src="fortress100.gif">
- <br><br>This section provides instructions to install Fortress and optiohally test with Directory Server.
- <h4>Steps to install the Fortress security system</h4>
+ <br><br>This section provides instructions to install Fortress and run the junit tests.
+ <h4>Steps to build the Fortress Core</h4>
<ol>
<li>
- Clone the Apache Fortress Core Git repo:
+ Clone the <a href="https://git-wip-us.apache.org/repos/asf?p=directory-fortress-core.git">Directory Fortress Core Git repo</a>:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
# git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-core.git
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/466d751a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-quickstart.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-quickstart.html b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-quickstart.html
deleted file mode 100644
index 2c55268..0000000
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-quickstart.html
+++ /dev/null
@@ -1,81 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
-<!--
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- *
--->
-<HTML>
-<HEAD>
- <title>Apache Fortress Quickstart</title>
-</HEAD>
-<BODY>
-<p>
- <h3>Overview</h3>
- The documents linked by this guide provides a how-to guide for installing Apache Fortress software.
- <br><br>
-<hr>
-<h4>Quickstart Guides</h4>
-The following topics are covered:
-<ol type="I">
- <li><a href="./apache-directory.html">Setup Apache Directory Server</a></li>
- <li><a href="./apache-fortress-core.html">Build Apache Fortress Core</a></li>
- <li><a href="./apache-fortress-realm.html">Build Apache Fortress Realm</a></li>
- <li><a href="./apache-tomcat.html">Setup Apache Tomcat Web Server</a></li>
- <li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
- <li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
-</ol>
-</p>
-<hr>
-<h4>Prerequisites</h4>
-<ol type="1">
- <li>Java 7 (or greater) SDK</li>
- <li><a href="http://ant.apache.org/">Apache Ant 1.8 (or greater)</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>
-</ol>
-<hr>
-<h4>Getting Started - Generating the tutorial's how-to guide</h4>
-This tutorial uses javadoc that is contained within the apache-fortress-core source archive. To generate, follow these instructions:
-<ol type="1">
- <li>Download the <a href="https://git-wip-us.apache.org/repos/asf?p=directory-fortress-core.git">apache-fortress-core source bundle</a> from Apache Git repo.</li>
- <li>Extract bundle</li>
- <li>Set JAVA_HOME</li>
- <li>Set M2_HOME</li>
- <li>Run this command from the root package:
- <pre>
- <p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-$ $M2_HOME/bin/mvn javadoc:javadoc
- </p>
- </pre>
- </li>
- <li>Open the help document: /*package home*/target/site/apidocs/org/apache/directory/fortress/core/doc-files/apache-fortress-quickstart.html</li>
- <li>Complete the desired sections under <b>Quickstart Guides</b> section</li>
-</ol>
-<hr>
-<h4>Infrastructure Installed</h4>
-<ol type="1">
- <li><a href="http://directory.apache.org/apacheds/">Apache Directory Server</a></li>
- <li><a href="http://directory.apache.org/studio/">Apache Directory Studio</a></li>
- <li><a href="http://directory.apache.org/fortress/">Apache Fortress</a></li>
- <li><a href="http://tomcat.apache.org/">Apache Tomcat Servlet Container</a></li>
-</ol>
-</p>
-<hr>
-If you find security flaws, or have questions about Apache Fortress, submit to <a href="http://mail-archives.apache.org/mod_mbox/directory-fortress/">Apache Fortress Discussion list</a>.
-</BODY>
-<p style="font: monospace; color: black; font-size: 6pt">Copyright 2003-2015, The Apache Software Foundation. All Rights Reserved.</p>
-</HTML>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/466d751a/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 ded8adf..9fbd0e0 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
@@ -31,7 +31,7 @@
<li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
<li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
</ul>
- <li><a href="./apache-fortress-quickstart.html">Apache Fortress Quickstart</a></li>
+ <li><a href="./ten-minute-guide.html">Ten Minute Guide</a></li>
</fieldset>
<hr>
</head>
@@ -43,7 +43,7 @@
<ol>
<li>
- Clone the Apache Fortress Realm Git repo:
+ Clone the <a href="https://git-wip-us.apache.org/repos/asf?p=directory-fortress-realm.git">Apache Fortress Realm Git repo</a>:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
# git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-realm.git
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/466d751a/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 56a90ed..ae75dfa 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
@@ -31,7 +31,7 @@
<li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
<li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
</ul>
- <li><a href="./apache-fortress-quickstart.html">Apache Fortress Quickstart</a></li>
+ <li><a href="./ten-minute-guide.html">Ten Minute Guide</a></li>
</fieldset>
<hr>
</head>
@@ -43,7 +43,7 @@
<ol>
<li>
- Clone the Apache Fortress Rest Git repo:
+ Clone the <a href="https://git-wip-us.apache.org/repos/asf?p=directory-fortress-enmasse.git">Apache Fortress Rest Git repo</a>:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
# git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-rest.git
@@ -96,10 +96,10 @@
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">
-# cp [directory-fortress-core]/config/fortress.properties [directory-fortress-rest]/src/main/resources
+# cp [directory-fortress-core]/config/fortress.properties [directory-fortress-enmasse]/src/main/resources
</p>
</pre>
- Where [directory-fortress-core] is base folder of the fortress core source package and [directory-fortress-rest] is the current package's home folder.
+ Where [directory-fortress-core] is base folder of the fortress core source package and [directory-fortress-enmasse] is the current package's home folder.
</li>
<br>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/466d751a/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 6f9107b..f544c42 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
@@ -31,7 +31,7 @@
<li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
<li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
</ul>
- <li><a href="./apache-fortress-quickstart.html">Apache Fortress Quickstart</a></li>
+ <li><a href="./ten-minute-guide.html">Ten Minute Guide</a></li>
</fieldset>
<hr>
</head>
@@ -43,7 +43,7 @@
<ol>
<li>
- Clone the Apache Fortress Web Git repo:
+ Clone the <a href="https://git-wip-us.apache.org/repos/asf?p=directory-fortress-commander.git">Apache Fortress Web Git repo</a>:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
# git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-web.git
@@ -86,10 +86,10 @@
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">
-# cp [directory-fortress-core]/config/fortress.properties [directory-fortress-web]/src/main/resources
+# cp [directory-fortress-core]/config/fortress.properties [directory-fortress-commander]/src/main/resources
</p>
</pre>
- Where [directory-fortress-core] is base folder of the fortress core source package and [directory-fortress-web] is the current package's home folder.
+ Where [directory-fortress-core] is base folder of the fortress core source package and [directory-fortress-commander] is the current package's home folder.
</li>
<br>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/466d751a/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
new file mode 100644
index 0000000..ba7dcba
--- /dev/null
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
@@ -0,0 +1,104 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+-->
+<HTML>
+<HEAD>
+ <title>Apache Fortress Ten Minute Guide</title>
+</HEAD>
+<BODY>
+<p>
+ <h3>Overview</h3>
+ The documents linked by this guide provides a how-to guide for downloading, building and installing Apache Fortress software from source in about ten minutes.
+ <br><br>
+<hr>
+<h4>Steps</h4>
+The following steps are covered by this tutorial and must be completed in order. Except for the rest and web components which are optional.
+<ol type="1">
+ <li><a href="./apache-directory.html">Setup Apache Directory Server and Studio</a></li>
+ <li><a href="./apache-fortress-core.html">Build Apache Fortress Core</a></li>
+ <li><a href="./apache-fortress-realm.html">Build Apache Fortress Realm</a></li>
+ <li><a href="./apache-tomcat.html">Setup Apache Tomcat Web Server</a></li>
+ <li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
+ <li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
+</ol>
+</p>
+<hr>
+<h4>Prerequisites</h4>
+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) SDK</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>
+</ol>
+<hr>
+<h4>Getting Started - Generating the tutorial's how-to guide</h4>
+This tutorial is contained within the javadoc of directory-fortress-core source archive. To generate, follow these instructions:
+<ol type="1">
+
+ <li>Obtain the source by cloning the <a href="https://git-wip-us.apache.org/repos/asf?p=directory-fortress-core.git">Directory Fortress Core Git repo</a>:
+ <pre>
+ <p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
+# git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-core.git
+ </p>
+ </pre>
+ </li>
+
+ <li>Change to the [directory-fortress-core] folder
+ <pre>
+ <p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
+# cd directory-fortress-core/
+ </p>
+ </pre>
+ 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>
+ <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
+ </p>
+ </pre>
+ </li>
+ <li>Open the help document: [directory-fortress-core]/target/site/apidocs/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
+ <br><br>Where [directory-fortress-core] is base folder of the fortress core source package.
+ </li>
+ <br>
+ <li>Complete the desired sections</li>
+</ol>
+<hr>
+<h4>Infrastructure Installed</h4>
+<ol type="1">
+ <li><a href="http://directory.apache.org/apacheds/">Apache Directory Server</a></li>
+ <li><a href="http://directory.apache.org/studio/">Apache Directory Studio</a></li>
+ <li><a href="http://directory.apache.org/fortress/">Apache Fortress</a></li>
+ <li><a href="http://tomcat.apache.org/">Apache Tomcat Servlet Container</a></li>
+</ol>
+</p>
+<hr>
+If you find security flaws, or have questions about Apache Fortress, submit to <a href="http://mail-archives.apache.org/mod_mbox/directory-fortress/">Apache Fortress Discussion list</a>.
+</BODY>
+<p style="font: monospace; color: black; font-size: 6pt">Copyright 2003-2015, The Apache Software Foundation. All Rights Reserved.</p>
+</HTML>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/466d751a/src/main/java/org/apache/directory/fortress/core/overview.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/overview.html b/src/main/java/org/apache/directory/fortress/core/overview.html
index 8cd812a..a45974f 100755
--- a/src/main/java/org/apache/directory/fortress/core/overview.html
+++ b/src/main/java/org/apache/directory/fortress/core/overview.html
@@ -24,6 +24,12 @@
<body>
A standards based and open source Identity Access Management Java SDK for LDAP v3 compliant systems.
<hr>
+ <h2>How do I start using Fortress?</h2>
+ <p>
+ Check out the new <a href="org/apache/directory/fortress/core/doc-files/ten-minute-guide.html">Ten Minute Guide</a>. It use maven to pull down and build fortress core, realm, web and rest components. It also
+ provides instructions for installing to tomcat and apacheds servers. This is a tutorial to get newcomers up and going with fortress in less than ten minutes.
+ </p>
+ <hr>
<h2>What can Fortress Core SDK do?</h2>
Contained within this SDK are APIs and utilities to perform authentication, authorization, administration, audit and password policies.
The most important package in this system is <A HREF="org/apache/directory/fortress/core/package-summary.html">org.apache.directory.fortress.core</A> which contains all of the public APIs that are called by outside programs.
@@ -59,9 +65,11 @@
<li><a href="http://ehcache.org/">Ehcache</a></li>
</ol>
</p>
+ <hr>
+ <h2>Where are the coding samples?</h2>
<p>
- Check out these <A HREF="../samples/overview-summary.html">samples</A> in the <b>org.apache.directory.fortress.core.samples</b> package to show how Fortress APIs can be used by outside clients. The
- <b>dist</b> target in build.xml creates the samples package in the /dist folder of this project and is intended to be used for experimentation.
+ The <A HREF="../samples/overview-summary.html">coding samples</A> are located within the <b>org.apache.directory.fortress.core.samples</b> package. The samples show how Fortress apis work. The
+ ant <b>dist</b> target in build.xml creates the samples package in the /dist folder of this project and is intended to be used for experimentation.
</p>
</body>
</html>
\ No newline at end of file