From 81acdcc8d555f55d8b1966768de2b9830f502698 Mon Sep 17 00:00:00 2001
From: Matthew Swift <matthew.swift@forgerock.com>
Date: Wed, 27 Nov 2013 18:45:57 +0000
Subject: [PATCH] Initial work towards OPENDJ-1195: Realign the SDK developer guide with the SDK trunk once the new Maven module and package layout has been validated
---
opendj-sdk/opendj-grizzly/src/site/xdoc/index.xml.vm | 5 ++
opendj-sdk/opendj-ldap-sdk/src/site/xdoc/index.xml.vm | 8 ++++
opendj-sdk/opendj-server2x-adapter/src/site/xdoc/index.xml.vm | 7 +++
opendj-sdk/opendj-rest2ldap-servlet/src/site/xdoc/index.xml.vm | 5 ++
opendj-sdk/src/site/site.xml | 1
opendj-sdk/opendj-core/src/site/xdoc/index.xml.vm | 5 ++
opendj-sdk/opendj-rest2ldap/src/site/xdoc/index.xml.vm | 5 ++
opendj-sdk/opendj-ldap-sdk-examples/src/site/xdoc/index.xml.vm | 36 +++++++++--------
8 files changed, 54 insertions(+), 18 deletions(-)
diff --git a/opendj-sdk/opendj-core/src/site/xdoc/index.xml.vm b/opendj-sdk/opendj-core/src/site/xdoc/index.xml.vm
index 3921a01..d9b6acb 100644
--- a/opendj-sdk/opendj-core/src/site/xdoc/index.xml.vm
+++ b/opendj-sdk/opendj-core/src/site/xdoc/index.xml.vm
@@ -35,6 +35,11 @@
${project.description}
</p>
</section>
+ <section name="Documentation for ${project.name}">
+ <p>
+ Javadoc for this module can be found <a href="apidocs/index.html">here</a>.
+ </p>
+ </section>
<section name="Get ${project.name}">
<p>
Start developing your applications by obtaining ${project.name}
diff --git a/opendj-sdk/opendj-grizzly/src/main/site/xdoc/index.xml.vm b/opendj-sdk/opendj-grizzly/src/site/xdoc/index.xml.vm
similarity index 95%
rename from opendj-sdk/opendj-grizzly/src/main/site/xdoc/index.xml.vm
rename to opendj-sdk/opendj-grizzly/src/site/xdoc/index.xml.vm
index 6638a83..7d88718 100644
--- a/opendj-sdk/opendj-grizzly/src/main/site/xdoc/index.xml.vm
+++ b/opendj-sdk/opendj-grizzly/src/site/xdoc/index.xml.vm
@@ -35,6 +35,11 @@
${project.description}
</p>
</section>
+ <section name="Documentation for ${project.name}">
+ <p>
+ Javadoc for this module can be found <a href="apidocs/index.html">here</a>.
+ </p>
+ </section>
<section name="Get ${project.name}">
<p>
Start developing your applications by obtaining ${project.name}
diff --git a/opendj-sdk/opendj-ldap-sdk-examples/src/site/xdoc/index.xml.vm b/opendj-sdk/opendj-ldap-sdk-examples/src/site/xdoc/index.xml.vm
index 9a8c41f..7899416 100644
--- a/opendj-sdk/opendj-ldap-sdk-examples/src/site/xdoc/index.xml.vm
+++ b/opendj-sdk/opendj-ldap-sdk-examples/src/site/xdoc/index.xml.vm
@@ -26,11 +26,11 @@
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
- <title>About OpenDJ LDAP SDK Examples</title>
- <author email="opendj-dev@forgerock.org">ForgeRock AS</author>
+ <title>About ${project.name}</title>
+ <author email="opendj-dev@forgerock.org">${project.organization.name}</author>
</properties>
<body>
- <section name="About OpenDJ LDAP SDK Examples">
+ <section name="About ${project.name}">
<p>This module contains example LDAP applications implemented using the
OpenDJ LDAP SDK:</p>
<ul>
@@ -113,29 +113,31 @@
</li>
</ul>
</section>
- <section name="Get the OpenDJ LDAP SDK Examples">
+ <section name="Documentation for ${project.name}">
<p>
- You can get the
- OpenDJ
- LDAP SDK examples using any of the following
+ Javadoc for this module can be found <a href="apidocs/index.html">here</a>.
+ </p>
+ </section>
+ <section name="Get ${project.name}">
+ <p>
+ You can get the OpenDJ LDAP SDK examples using any of the following
methods:
- </p>
+ </p>
<subsection name="Download">
<p>
- The easiest way to download the OpenDJ LDAP SDK Examples and all of
- its
- dependencies is to get the latest version from our
- <a
- href="${mavenRepoSnapshots}/org/forgerock/opendj/opendj-ldap-sdk-examples/${currentSDKversion}">repository</a>
- .
+ Pre-built binaries can be downloaded directly from the ForgeRock Maven
+ repository:
</p>
+ <ul>
+ <li><a href="${mavenRepoReleases}/org/forgerock/opendj/${project.artifactId}">Stable releases</a></li>
+ <li><a href="${mavenRepoSnapshots}/org/forgerock/opendj/${project.artifactId}/${project.version}">Latest development snapshot</a></li>
+ </ul>
</subsection>
<subsection name="Build">
<p>
For the DIY enthusiasts you can build it yourself by checking out the
- latest code using
- <a href="source-repository.html">Subversion</a>
- and building it with Maven 3.
+ latest code using <a href="source-repository.html">Subversion</a> and
+ building it with Maven 3.
</p>
</subsection>
</section>
diff --git a/opendj-sdk/opendj-ldap-sdk/src/site/xdoc/index.xml.vm b/opendj-sdk/opendj-ldap-sdk/src/site/xdoc/index.xml.vm
index 61da15d..569699f 100644
--- a/opendj-sdk/opendj-ldap-sdk/src/site/xdoc/index.xml.vm
+++ b/opendj-sdk/opendj-ldap-sdk/src/site/xdoc/index.xml.vm
@@ -48,6 +48,14 @@
experimental RFCs that are supported by modern LDAP servers.
</p>
</section>
+ <section name="Documentation for ${project.name}">
+ <p>
+ Javadoc for this module can be found <a href="apidocs/index.html">here</a>.
+ Read the <a href="../doc/dev-guide/index.html">developer guide</a> for
+ a deeper understanding of LDAP application development, as well as a
+ detailed over of LDAP itself.
+ </p>
+ </section>
<section name="Get the OpenDJ LDAP SDK">
<p>
You can start developing your LDAP applications now by obtaining the
diff --git a/opendj-sdk/opendj-rest2ldap-servlet/src/site/xdoc/index.xml.vm b/opendj-sdk/opendj-rest2ldap-servlet/src/site/xdoc/index.xml.vm
index 6638a83..7d88718 100644
--- a/opendj-sdk/opendj-rest2ldap-servlet/src/site/xdoc/index.xml.vm
+++ b/opendj-sdk/opendj-rest2ldap-servlet/src/site/xdoc/index.xml.vm
@@ -35,6 +35,11 @@
${project.description}
</p>
</section>
+ <section name="Documentation for ${project.name}">
+ <p>
+ Javadoc for this module can be found <a href="apidocs/index.html">here</a>.
+ </p>
+ </section>
<section name="Get ${project.name}">
<p>
Start developing your applications by obtaining ${project.name}
diff --git a/opendj-sdk/opendj-rest2ldap/src/site/xdoc/index.xml.vm b/opendj-sdk/opendj-rest2ldap/src/site/xdoc/index.xml.vm
index 6638a83..7d88718 100644
--- a/opendj-sdk/opendj-rest2ldap/src/site/xdoc/index.xml.vm
+++ b/opendj-sdk/opendj-rest2ldap/src/site/xdoc/index.xml.vm
@@ -35,6 +35,11 @@
${project.description}
</p>
</section>
+ <section name="Documentation for ${project.name}">
+ <p>
+ Javadoc for this module can be found <a href="apidocs/index.html">here</a>.
+ </p>
+ </section>
<section name="Get ${project.name}">
<p>
Start developing your applications by obtaining ${project.name}
diff --git a/opendj-sdk/opendj-server2x-adapter/src/site/xdoc/index.xml.vm b/opendj-sdk/opendj-server2x-adapter/src/site/xdoc/index.xml.vm
index 6638a83..181ef3e 100644
--- a/opendj-sdk/opendj-server2x-adapter/src/site/xdoc/index.xml.vm
+++ b/opendj-sdk/opendj-server2x-adapter/src/site/xdoc/index.xml.vm
@@ -35,11 +35,16 @@
${project.description}
</p>
</section>
+ <section name="Documentation for ${project.name}">
+ <p>
+ Javadoc for this module can be found <a href="apidocs/index.html">here</a>.
+ </p>
+ </section>
<section name="Get ${project.name}">
<p>
Start developing your applications by obtaining ${project.name}
using any of the following methods:
- </p>
+ </p>
<subsection name="Maven">
<p>
By far the simplest method is to develop your application using Maven
diff --git a/opendj-sdk/src/site/site.xml b/opendj-sdk/src/site/site.xml
index 9006413..01babf0 100644
--- a/opendj-sdk/src/site/site.xml
+++ b/opendj-sdk/src/site/site.xml
@@ -68,6 +68,7 @@
<item name="Toolkit" href="opendj-ldap-toolkit" />
<item name="Rest2LDAP" href="opendj-rest2ldap" />
<item name="Rest2LDAP Servlet" href="opendj-rest2ldap-servlet" />
+ <item name="Server 2.x Adapter" href="opendj-server2x-adapter" />
</menu>
<menu name="OpenDJ Mobile Apps" inherit="top">
--
Gitblit v1.10.0