From 3ba678fee0d6a6d119f5e6a0ffd83111c46f3e4b Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Wed, 10 Apr 2013 13:42:34 +0000
Subject: [PATCH] CR-1531 Fix for OPENDJ-834: Fix download links in OpenDJ docs
---
opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml | 30 +++------
opendj-sdk/opendj3/src/main/docbkx/dev-guide/index.xml | 4
opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml | 17 +++--
opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml | 65 +++++++++------------
opendj-sdk/opendj3/src/main/docbkx/shared/itemizedlist-download.xml | 53 +++++++++++++++++
5 files changed, 105 insertions(+), 64 deletions(-)
diff --git a/opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml b/opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
index 226405b..2b8bbf4 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2012 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
-->
<chapter xml:id='chap-get-sdk'
@@ -48,7 +48,7 @@
for use with any server that complies with the <citetitle>Lightweight
Directory Access Protocol (LDAP): Technical Specification Road
Map</citetitle>, <link xlink:href='http://tools.ietf.org/html/rfc4510'
- >RFC 4510</link>.</para>
+ xlink:show="new">RFC 4510</link>.</para>
<para>OpenDJ LDAP SDK brings you easy-to-use connection management, connection
pooling, load balancing, and all the standard LDAP operations to read and
@@ -83,7 +83,7 @@
<para>Before you either download a build of OpenDJ LDAP SDK, or get the
source code to build your own SDK, make sure you have a Java Development Kit
installed. See the <citetitle>Release Notes</citetitle> section on
- <link xlink:href="release-notes#prerequisites-java"
+ <link xlink:href="release-notes#prerequisites-java" xlink:show="new"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Java
Environment</citetitle></link> requirements.</para>
@@ -131,17 +131,17 @@
</step>
</procedure>
- <procedure xml:id="install-stable-sdk">
- <title>To Install the Latest Stable SDK & Tools</title>
+ <procedure xml:id="install-latest-sdk">
+ <title>To Install the Latest SDK & Tools</title>
<indexterm>
<primary>Installing</primary>
<secondary>From download</secondary>
</indexterm>
<step>
- <para>Download the latest OpenDJ LDAP Client Toolkit from the <link
- xlink:href="http://forgerock.org/opendj.html"
- xlink:show="new">download page</link>.</para>
+ <para>Download the latest OpenDJ LDAP Client Toolkit nightly build from the
+ <link xlink:href="http://forgerock.org/opendj.html" xlink:show="new"
+ >Nightly Builds</link> page.</para>
</step>
<step>
<para>Unzip the bundle,
@@ -162,12 +162,12 @@
<filename>opendj-ldap-toolkit-<?eval ${currentSDKversion}?>/lib/</filename>.</para>
<screen>(UNIX)
$ export CLASSPATH=/path/to/lib/grizzly-framework-<?eval ${grizzlyFrameworkVersion}?>.jar:$CLASSPATH
-$ export CLASSPATH=/path/to/lib/i18n-core-1.4.0.jar:$CLASSPATH
+$ export CLASSPATH=/path/to/lib/i18n-core-<?eval ${i18nFrameworkVersion}?>.jar:$CLASSPATH
$ export CLASSPATH=/path/to/lib/opendj-ldap-sdk-<?eval ${currentSDKversion}?>.jar:$CLASSPATH
</screen>
<screen>(Windows)
C:\>set CLASSPATH=\\path\to\lib\grizzly-framework-<?eval ${grizzlyFrameworkVersion}?>.jar:%CLASSPATH%
-C:\>set CLASSPATH=\\path\to\lib\i18n-core-1.4.0.jar:%CLASSPATH%
+C:\>set CLASSPATH=\\path\to\lib\i18n-core-<?eval ${i18nFrameworkVersion}?>.jar:%CLASSPATH%
C:\>set CLASSPATH=\\path\to\lib\opendj-ldap-sdk-<?eval ${currentSDKversion}?>.jar:%CLASSPATH%</screen>
</step>
</procedure>
@@ -186,20 +186,8 @@
<step>
<para>Check out the source code.</para>
<screen>$ svn co https://svn.forgerock.org/opendj/trunk/opendj3
-Error validating server certificate for 'https://svn.forgerock.org:443':
- - The certificate is not issued by a trusted authority. Use the
- fingerprint to validate the certificate manually!
-Certificate information:
- - Hostname: svn.forgerock.org
- - Valid: from Wed, 23 Feb 2011 00:30:37 GMT until Thu, 23 Feb 2012 21:00:01 GMT
- - Issuer: Secure Digital Certificate Signing, StartCom Ltd., IL
- - Fingerprint: 73:96:5c:68:2c:f3:57:0e:e9:ee:6d:74:08:1b:34:16:53:b8:bd:39
-(R)eject, accept (t)emporarily or accept (p)ermanently? p
...
-A opendj3/README
-U opendj3
-...
-Checked out revision 6985.</screen>
+Checked out revision <replaceable>XXXX</replaceable>.</screen>
</step>
<step>
<para>Build the modules and install them in the local repository.</para>
@@ -207,20 +195,23 @@
$ mvn install
[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
-[INFO] Reactor build order:
-[INFO]
+[INFO] Reactor Build Order:
+[INFO]
[INFO] OpenDJ Directory Services Project
-[INFO] OpenDJ Maven Build Tools
[INFO] OpenDJ LDAP SDK
[INFO] OpenDJ LDAP Toolkit
[INFO] OpenDJ LDAP SDK Examples
-...
+[INFO] OpenDJ Commons REST Adapter
+[INFO] OpenDJ Commons REST LDAP Gateway
+[INFO] OpenDJ Server 2.x Adapter
+[INFO]
+ ...
[INFO] ------------------------------------------------------------------------
-[INFO] BUILD SUCCESSFUL
+[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
-[INFO] Total time: 56.658s
-[INFO] Finished at: Wed Jun 08 09:19:57 CEST 2011
-[INFO] Final Memory: 27M/87M
+[INFO] Total time: 2:51.315s
+[INFO] Finished at: Wed Apr 10 14:28:36 CEST 2013
+[INFO] Final Memory: 37M/382M
[INFO] ------------------------------------------------------------------------</screen>
</step>
<step>
@@ -230,15 +221,17 @@
<step>
<para>Add the <filename>opendj-ldap-toolkit-<?eval ${currentSDKversion}?>/bin</filename>
(UNIX) or <filename>opendj-ldap-toolkit-<?eval ${currentSDKversion}?>\bat</filename>
- (Windows) directory to your
- PATH.</para>
+ (Windows) directory to your PATH.</para>
</step>
<step>
<para>Set your CLASSPATH to include the OpenDJ LDAP SDK library,
<filename>opendj-ldap-sdk-<?eval ${currentSDKVersion}?>.jar</filename>,
- the I18N core library, <filename>i18n-core-1.4.0.jar</filename>, and the Grizzly
- framework, <filename>grizzly-framework-<?eval ${grizzlyFrameworkVersion}?>.jar</filename>
- under <filename>opendj-ldap-toolkit-<?eval ${currentSDKversion}?>/lib/</filename>.</para>
+ the I18N core library,
+ <filename>i18n-core-<?eval ${i18nFrameworkVersion}?>.jar</filename>, and the
+ Grizzly framework,
+ <filename>grizzly-framework-<?eval ${grizzlyFrameworkVersion}?>.jar</filename>
+ under
+ <filename>opendj-ldap-toolkit-<?eval ${currentSDKversion}?>/lib/</filename>.</para>
</step>
</procedure>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/dev-guide/index.xml b/opendj-sdk/opendj3/src/main/docbkx/dev-guide/index.xml
index 87fdc22..3f40373 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/dev-guide/index.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/dev-guide/index.xml
@@ -77,9 +77,9 @@
<para>You can find the tools under the <filename>bin/</filename> or
<filename>bat\</filename> folder where you installed OpenDJ LDAP SDK
toolkit as described in the procedure explaining how <link
- xlink:href="dev-guide#install-stable-sdk"
+ xlink:href="dev-guide#install-latest-sdk"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>To Install the
- Latest Stable SDK & Tools</citetitle></link>. For example,
+ Latest SDK & Tools</citetitle></link>. For example,
<filename>/path/to/opendj-ldap-toolkit-<?eval ${currentSDKversion}?>/bin</filename>.</para>
</partintro>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml
index f9e429c..e0fa752 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-cli.xml
@@ -40,7 +40,7 @@
<step xml:id="check-for-java">
<para>Make sure you have the correct Java environment installed, as
described in the <citetitle>Release Notes</citetitle> section on <link
- xlink:href="release-notes#prerequisites-java"
+ xlink:href="release-notes#prerequisites-java" xlink:show="new"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Java
Environment</citetitle></link> requirements.</para>
@@ -56,22 +56,25 @@
<step xml:id="download-opendj">
<indexterm><primary>Downloading OpenDJ</primary></indexterm>
- <para>Get the appropriate installation packages from the <link
- xlink:href='http://www.forgerock.org/opendj.html'
- >OpenDJ download page</link>.</para>
+ <xinclude:include href="../shared/itemizedlist-download.xml" />
+
<variablelist>
+ <para>The following server software is available.</para>
+
<varlistentry>
<term>OpenDJ-<?eval ${docTargetVersion}?>.zip</term>
<listitem>
<para>Cross-platform OpenDJ directory server installation files</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>opendj.zip</term>
<listitem>
<para>SVR4 format native packages for Solaris</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>OpenDJ-<?eval ${docTargetVersion}?>-DSML.war</term>
<listitem>
@@ -232,7 +235,7 @@
<term>Initial root user password</term>
<listitem>
<para>The root user will use simple, password-based authentication.
- Later you can limit cleartext access to avoid snooping, but for
+ Later you can limit clear text access to avoid snooping, but for
now use a strong password here unless this is a throwaway server.</para>
</listitem>
</varlistentry>
@@ -523,8 +526,8 @@
<para>The following command reads Babs Jensen's entry through the gateway
to the backend holding data from <filename>Example.ldif</filename>.</para>
- <screen>$ curl
- http://opendj.example.com:8080/rest2ldap/users/bjensen?_prettyPrint=true
+ <screen
+ >$ curl http://opendj.example.com:8080/rest2ldap/users/bjensen?_prettyPrint=true
{
"_rev" : "000000002ee3b764",
"schemas" : [ "urn:scim:schemas:core:1.0" ],
diff --git a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml
index 26e70f8..77462fa 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/install-guide/chap-install-gui.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
-->
<chapter xml:id='chap-install-gui'
@@ -35,19 +35,17 @@
<para>If you want only to try OpenDJ server software, and you do not plan to
store any real or important data that you want to keep, then read only this
- section, or just try out installation without reading any further. Visit the
- <link xlink:href='http://www.forgerock.org/opendj.html'>download
- page</link>, and click the first link on the left for the latest release
- to start the Java WebStart installer directly from your browser.</para>
+ section, or just try out installation without reading any further.</para>
- <para>Java WebStart lets you perform an installation of OpenDJ directory
- server starting with a click in your web browser, which can be a great way
- to try OpenDJ directory server for the first time, or to do a quick test
- installation. You can also upgrade an OpenDJ directory server through the
- WebStart installer.</para>
+ <xinclude:include href="../shared/itemizedlist-download.xml" />
+
+ <para>The Quick Setup and Nightly Build links use Java WebStart to let you
+ perform an installation of OpenDJ directory server starting with a click in
+ your web browser, which can be a great way to try OpenDJ directory server for
+ the first time, or to do a quick test installation.</para>
<note>
- <para>OpenDJ directory server relies on Java 6, so if your browser
+ <para>OpenDJ directory server relies on Java 6 or later, so if your browser
picks up an old installation of Java 5 for example, installation can
fail. You might see an application error message such as this:</para>
@@ -72,12 +70,6 @@
<screen>$ export PATH=/path/to/java6/bin:$PATH
$ javaws <replaceable>URL-to-QuickSetup-Installer</replaceable></screen>
- <para>The <replaceable>URL-to-QuickSetup-Installer</replaceable> includes the
- version of OpenDJ. For example,
- <replaceable>URL-to-QuickSetup-Installer</replaceable> for version
- <?eval ${docTargetVersion}?> is
- <literal>http://download.forgerock.org/downloads/opendj/<?eval ${docTargetVersion}?>/install/QuickSetup.jnlp</literal>.</para>
-
<para>The WebStart installer corresponds to what you start if you download
OpenDJ-<?eval ${docTargetVersion}?>.zip, unzip the file, and then run
OpenDJ-<?eval ${docTargetVersion}?>/setup (UNIX), OpenDJ-<?eval
@@ -147,7 +139,7 @@
<caption><para>Run <command>OpenDJ-<?eval
${docTargetVersion}?>/bin/control-panel</command> (UNIX), double-click
<command>OpenDJ-<?eval ${docTargetVersion}?>\bat\control-panel.bat</command>
- (Windows), or bin/Control Panel.app (Mac OS X) to launch the Control Panel
- again later.</para></caption>
+ (Windows), or <command>bin/Control Panel.app</command> (Mac OS X) to launch
+ the Control Panel again later.</para></caption>
</mediaobject>
</chapter>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/shared/itemizedlist-download.xml b/opendj-sdk/opendj3/src/main/docbkx/shared/itemizedlist-download.xml
new file mode 100644
index 0000000..00123fa
--- /dev/null
+++ b/opendj-sdk/opendj3/src/main/docbkx/shared/itemizedlist-download.xml
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2013 ForgeRock AS
+ !
+-->
+<itemizedlist
+ xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
+ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
+ xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xlink='http://www.w3.org/1999/xlink'>
+
+ <para>Download OpenDJ software from one of the following locations.</para>
+
+ <listitem>
+ <para>The ForgeRock <link xlink:href="http://forgerock.com/download-stack/"
+ xlink:show="new">Enterprise Downloads</link> page has the latest stable,
+ supported release of OpenDJ and the other products in the ForgeRock identity
+ stack.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <link xlink:href="http://forgerock.org/opendj.html"
+ xlink:show="new">Nightly Builds</link> page posts links to the latest nightly
+ builds of OpenDJ software. Note that these builds are the working version
+ from the trunk and are not for use in a production environment.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <link xlink:href="http://forgerock.org/opendj-archive.html"
+ xlink:show="new">Community Archives</link> page includes stable community
+ builds for previous releases of OpenDJ software.</para>
+ </listitem>
+</itemizedlist>
--
Gitblit v1.10.0