You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by ak...@apache.org on 2004/02/04 05:14:56 UTC
svn commit: rev 6465 - in incubator/directory/sitedocs/trunk/sitedocs/xdocs: . community community/history community/process community/who doc related sandbox subprojects subprojects/janus subprojects/ldap subprojects/naming subprojects/sitedocs subprojects/snickers
Author: akarasulu
Date: Tue Feb 3 20:14:55 2004
New Revision: 6465
Added:
incubator/directory/sitedocs/trunk/sitedocs/xdocs/irc.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/nav-template.txt
Modified:
incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/process/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/who/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/doc/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/index.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/related/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/sandbox/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/index.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/janus/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/ldap/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/naming/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/index.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/snickers/navigation.xml
Log:
Changed navigations so they all use the label Subprojects instead of
Sub-Projects and added site generation documentation. Also added some
substantial documentation on how to integrate your subproject with the
top level sitedocs generated site, how to build it and deploy it within
the incubator.
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/navigation.xml Tue Feb 3 20:14:55 2004
@@ -31,11 +31,12 @@
</item>
</item>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html"/>
+ <item name="Subprojects" href="/subprojects/index.html"/>
<item name="Documentation" href="/doc/index.html"/>
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/navigation.xml Tue Feb 3 20:14:55 2004
@@ -25,11 +25,12 @@
<item name="History" href="/community/history/index.html"/>
</item>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html"/>
+ <item name="Subprojects" href="/subprojects/index.html"/>
<item name="Documentation" href="/doc/index.html"/>
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/process/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/process/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/process/navigation.xml Tue Feb 3 20:14:55 2004
@@ -35,11 +35,12 @@
<item name="History" href="/community/history/index.html"/>
</item>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html"/>
+ <item name="Subprojects" href="/subprojects/index.html"/>
<item name="Documentation" href="/doc/index.html"/>
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/who/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/who/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/who/navigation.xml Tue Feb 3 20:14:55 2004
@@ -31,11 +31,12 @@
<item name="History" href="/community/history/index.html"/>
</item>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html"/>
+ <item name="Subprojects" href="/subprojects/index.html"/>
<item name="Documentation" href="/doc/index.html"/>
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/doc/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/doc/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/doc/navigation.xml Tue Feb 3 20:14:55 2004
@@ -21,7 +21,7 @@
<item name="Overview" href="/index.html"/>
<item name="Community" href="/community/index.html"/>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html"/>
+ <item name="Subprojects" href="/subprojects/index.html"/>
<item name="Documentation" href="/doc/index.html">
<item name="Wiki" href="/doc/wiki.html"/>
<item name="Articles" href="/doc/articles.html"/>
@@ -29,6 +29,7 @@
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/index.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/index.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/index.xml Tue Feb 3 20:14:55 2004
@@ -34,47 +34,91 @@
<section name="What is it?">
<p>
- Describe the project and its intentions here.
+ The Directory Project is an attempt to centralize all naming and
+ directory needs in one place at the ASF. This incubator project is
+ language independent however its primary goal to graduate the incubator
+ is to provide a pure Java LDAP directory server called Eve. Other
+ projects have come to be to factor out useful code from the server and
+ some have just found their final home. These subprojects are described
+ in the section below and to a greater detail within their own
+ documentation.
</p>
</section>
- <section name="Sub-Projects">
+ <section name="Subprojects">
<table>
- <tr><th>Sub-Project</th><th>Description</th></tr>
+ <tr><th>Subproject</th><th>Description</th></tr>
<tr>
<td><a href="subprojects/eve/index.html">Eve</a></td>
<td>
- Eve is a modular LDAP server written in pure Java.
+ Eve is a modular LDAP server written in pure Java. The Eve server
+ is being completely designed from the ground up here within the
+ incubator and will gain from the experience of building the old
+ LDAPd server.
</td>
</tr>
<tr>
<td><a href="subprojects/ldap/index.html">LDAP</a></td>
<td>
- LDAP commons code ...
+ Commons code dealing with the Lightweight Directory Access Protocol
+ is managed under this subproject. This will include a common API
+ for composing and reading LDAP Message envelopes and various LDAP
+ clients including JNDI LDAP providers.
</td>
</tr>
<tr>
<td><a href="subprojects/janus/index.html">Janus</a></td>
<td>
- Janus AAA implementation ...
+ Janus is a <a href="http://ietf.org/rfc/rfc2903.txt?number=2903">AAA
+ </a> framework and possibly in the future a AAA protocol
+ implementation. According to the <a href="http://ietf.org">IETF</a>
+ the Authentication, Authorization and Accounting working group was
+ formed to specify a general Authentication, Authorization, and
+ Accounting protocol for the Internet. Janus is an implementation of
+ that specification.
</td>
</tr>
<tr>
<td><a href="subprojects/naming/index.html">Naming</a></td>
<td>
- Naming commons code ...
+ There is a set of core functionality common to all JNDI providers
+ and JNDI does not necessarily revolve around LDAP and X.500
+ directories. The naming subproject will contain common JNDI code
+ along with various JNDI provider's. A J2EE ENC, environment naming
+ context would be one implementation. If you're looking to build a
+ JNDI provider you might want to take a look in here before
+ proceeding.
</td>
</tr>
<tr>
<td><a href="subprojects/snickers/index.html">Snickers</a></td>
<td>
- ASN.1 tools and APIs ...
+ Both LDAP and X.500 directories have their data structures defined
+ using the Abstract Syntax Notation One language. The entire X.500
+ ITU series of specifications use ASN.1 to define the data structures
+ that are transmitted over the wire using various encodings (like
+ BER, DER, PER, and XER). ASN.1 is used as a Protocol Data Unit
+ definition syntax in several other protocols like SNMP. Snickers
+ will contain code factored out of the Eve and LDAP subprojects used
+ to encode and decode ASN.1 messages. Snickers will eventually grow
+ to contain various language stub generators (ASN.1 compilers) that
+ create stub structures, classes and interfaces for ASN.1
+ definitions. Snickers, in this way, is a SNACC and SNACC4J
+ replacement for C/C++ and Java respectively.
</td>
+ </tr>
+
+ <tr>
+ <td><a href="subprojects/snickers/index.html">Sitedocs</a></td>
+ <td>
+ The structure and organization of the entire website and how to
+ manage it is discribed here.
+ </td>
</tr>
</table>
</section>
Added: incubator/directory/sitedocs/trunk/sitedocs/xdocs/irc.xml
==============================================================================
--- (empty file)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/irc.xml Tue Feb 3 20:14:55 2004
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Apache Directory Project: IRC Channels</title>
+ </properties>
+
+ <body>
+
+ <section name="Directory IRC Channels">
+
+ <subsection name="WARNING: Channels are Logged!">
+ <p>
+ The perferred medium of communication is by email on the mailing lists
+ however we have two IRC channels we use to track live get togethers,
+ and conversations.
+ </p>
+ <p>
+ For the sake of history and tracking conversations we are logging both
+ channels and archiving them. Please keep this in mind when conversing
+ on these lists.
+ </p>
+ </subsection>
+
+ <subsection name="Channels">
+ <p>
+ Right now we primarily use the dev channel for the team and basically
+ ask users to take their discussions there until a user community is
+ established. The amount of chatter on both channels may be almost nil
+ until the community picks up.
+ </p>
+
+ <table>
+ <tr>
+ <th>Channel</th>
+ <th>Purpose</th>
+ <th>Server</th>
+ <th>Archived</th>
+ </tr>
+ <tr>
+ <td>#directory</td>
+ <td>General and user chat</td>
+ <td>irc.freenode.net</td>
+ <td><a href="http://www.sol-earth.com/directory">Yes</a></td>
+ </tr>
+ <tr>
+ <td>#directory-dev</td>
+ <td>Developer babble</td>
+ <td>irc.freenode.net</td>
+ <td><a href="http://www.sol-earth.com/directory-dev">Yes</a></td>
+ </tr>
+ </table>
+ </subsection>
+
+ </section>
+ </body>
+</document>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/navigation.xml Tue Feb 3 20:14:55 2004
@@ -21,11 +21,12 @@
<item name="Overview" href="/index.html"/>
<item name="Community" href="/community/index.html"/>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html"/>
+ <item name="Subprojects" href="/subprojects/index.html"/>
<item name="Documentation" href="/doc/index.html"/>
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/related/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/related/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/related/navigation.xml Tue Feb 3 20:14:55 2004
@@ -21,7 +21,7 @@
<item name="Overview" href="/index.html"/>
<item name="Community" href="/community/index.html"/>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html"/>
+ <item name="Subprojects" href="/subprojects/index.html"/>
<item name="Documentation" href="/doc/index.html"/>
</menu>
@@ -34,6 +34,7 @@
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/sandbox/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/sandbox/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/sandbox/navigation.xml Tue Feb 3 20:14:55 2004
@@ -21,11 +21,12 @@
<item name="Overview" href="/index.html"/>
<item name="Community" href="/community/index.html"/>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html"/>
+ <item name="Subprojects" href="/subprojects/index.html"/>
<item name="Documentation" href="/doc/index.html"/>
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/index.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/index.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/index.xml Tue Feb 3 20:14:55 2004
@@ -23,7 +23,10 @@
</td>
<td>
<p>
- Eve is a modular LDAP server written in pure Java.
+ Eve is a modular LDAP server written in pure Java. The Eve server
+ is being completely designed from the ground up here within the
+ incubator and will gain from the experience of building the old
+ LDAPd server.
</p>
</td>
</tr>
@@ -34,7 +37,10 @@
</td>
<td>
<p>
- Coming soon ...
+ Commons code dealing with the Lightweight Directory Access Protocol
+ is managed under this subproject. This will include a common API
+ for composing and reading LDAP Message envelopes and various LDAP
+ clients including JNDI LDAP providers.
</p>
</td>
</tr>
@@ -45,7 +51,13 @@
</td>
<td>
<p>
- Coming soon ...
+ Janus is a <a href="http://ietf.org/rfc/rfc2903.txt?number=2903">
+ AAA </a> framework and possibly in the future a AAA protocol
+ implementation. According to the <a href="http://ietf.org">IETF
+ </a> the Authentication, Authorization and Accounting working
+ group was formed to specify a general Authentication,
+ Authorization, and Accounting protocol for the Internet. Janus
+ is an implementation of that specification.
</p>
</td>
</tr>
@@ -56,7 +68,13 @@
</td>
<td>
<p>
- Coming soon ...
+ There is a set of core functionality common to all JNDI providers
+ and JNDI does not necessarily revolve around LDAP and X.500
+ directories. The naming subproject will contain common JNDI code
+ along with various JNDI provider's. A J2EE ENC, environment
+ naming context would be one implementation. If you're looking to
+ build a JNDI provider you might want to take a look in here before
+ proceeding.
</p>
</td>
</tr>
@@ -67,11 +85,30 @@
</td>
<td>
<p>
- Coming soon ...
+ Both LDAP and X.500 directories have their data structures defined
+ using the Abstract Syntax Notation One language. The entire X.500
+ ITU series of specifications use ASN.1 to define the data
+ structures that are transmitted over the wire using various
+ encodings (like BER, DER, PER, and XER). ASN.1 is used as a
+ Protocol Data Unit definition syntax in several other protocols
+ like SNMP. Snickers will contain code factored out of the Eve
+ and LDAP subprojects used to encode and decode ASN.1 messages.
+ Snickers will eventually grow to contain various language stub
+ generators (ASN.1 compilers) that create stub structures, classes
+ and interfaces for ASN.1 definitions. Snickers, in this way, is
+ a SNACC and SNACC4J replacement for C/C++ and Java respectively.
</p>
</td>
</tr>
+ <tr>
+ <td><a href="subprojects/snickers/index.html">Sitedocs</a></td>
+ <td>
+ The structure and organization of the entire website and how to
+ manage it is discribed here.
+ </td>
+ </tr>
+
</table>
</section>
</body>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/janus/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/janus/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/janus/navigation.xml Tue Feb 3 20:14:55 2004
@@ -21,7 +21,7 @@
<item name="Overview" href="/index.html"/>
<item name="Community" href="/community/index.html"/>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html">
+ <item name="Subprojects" href="/subprojects/index.html">
<item name="Eve" href="/subprojects/eve/index.html"/>
<item name="LDAP" href="/subprojects/ldap/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
@@ -33,6 +33,7 @@
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/ldap/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/ldap/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/ldap/navigation.xml Tue Feb 3 20:14:55 2004
@@ -21,7 +21,7 @@
<item name="Overview" href="/index.html"/>
<item name="Community" href="/community/index.html"/>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html">
+ <item name="Subprojects" href="/subprojects/index.html">
<item name="Eve" href="/subprojects/eve/index.html"/>
<item name="LDAP" href="/subprojects/ldap/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
@@ -33,6 +33,7 @@
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/naming/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/naming/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/naming/navigation.xml Tue Feb 3 20:14:55 2004
@@ -21,7 +21,7 @@
<item name="Overview" href="/index.html"/>
<item name="Community" href="/community/index.html"/>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html">
+ <item name="Subprojects" href="/subprojects/index.html">
<item name="Eve" href="/subprojects/eve/index.html"/>
<item name="LDAP" href="/subprojects/ldap/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
@@ -33,6 +33,7 @@
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/navigation.xml Tue Feb 3 20:14:55 2004
@@ -20,7 +20,7 @@
<item name="Overview" href="/index.html"/>
<item name="Community" href="/community/index.html"/>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html">
+ <item name="Subprojects" href="/subprojects/index.html">
<item name="Eve" href="/subprojects/eve/index.html"/>
<item name="LDAP" href="/subprojects/ldap/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
@@ -32,6 +32,7 @@
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/index.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/index.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/index.xml Tue Feb 3 20:14:55 2004
@@ -6,6 +6,26 @@
</properties>
<body>
+
+ <section name="TODO">
+ <ul>
+ <li>
+ Separate out these sections into their own pages and make this
+ page an overview page with a listing of topics in a table. Too
+ much here in one place.
+ </li>
+
+ <li>
+ Figure out what to add here as the guys use this to add their own
+ subproject sections. Refine it and make it flow better.
+ </li>
+
+ <li>
+ Spell and grammar check it.
+ </li>
+ </ul>
+ </section>
+
<section name="Overview">
<p>
This project documents what is to be the umbrella website for all
@@ -95,6 +115,326 @@
Sitedocs must be maintained by all subprojects to keep the overall
site consistant.
</p>
+ </section>
+
+ <section name="Subproject Integration Howto">
+ <p>
+ At the present time there are stubs that have been placed
+ into the respective directories for the subprojects. So under <b>
+ sitedocs/xdocs/subprojects</b> where subproject directories are
+ contained a stub <b><em>index.xml</em></b> and <b><em>navigation.xml
+ </em></b> will be found.
+ </p>
+
+ <p>
+ We have done this to prevent users from encountering broken links on the
+ site. Once you have built your subproject's site and are sure it works
+ remove the respective stubs for your subproject. If you do not do so
+ your content may be over written by the stubs if someone deploys the
+ top level site without generating your subproject's content. So please
+ rm these stubs from the repository once your subproject is up.
+ </p>
+
+ <p>
+ Below we point out all the files and changes that need to be made in
+ order to make your subproject integrate into the top level site to
+ maintain a consistant look and feel.
+ </p>
+
+ <subsection name="project.properties">
+ <p>
+ Add this to your maven project.properties at the top level of the
+ project:
+ </p>
+
+ <source>
+maven.xdoc.date=left
+maven.ui.banner.background=#FFFFFF
+maven.xdoc.includeProjectDocumentation=no
+maven.xdoc.poweredby.image=
+maven.xdoc.jsl = file:/${basedir}/../../../sitedocs/trunk/sitedocs/src/etc/site.jsl
+ </source>
+
+ <p>
+ The last property is a relative reference to the
+ <b>sitedocs/src/etc/site.jsl</b> file. You can copy this if you want
+ into your own directory but I recommend you keep a reference since
+ it effects the sense of site continuity and the general look and feel
+ that is carried along on every subproject. There is no need to keep
+ them the same but it just might look better. Copying the file and
+ versioning it in a subproject directory will allow the top and
+ subproject sites to diverge.
+ </p>
+ </subsection>
+
+ <subsection name="project.xml">
+ <p>
+ You have to make a couple of minor changes to the project.xml to make
+ the project and banner logos look the same on the TLP site and the
+ subproject site. Here's the set of tags and the values they should
+ be set to in order to maintain consistancy:
+ </p>
+
+ <source>
+<name>Apache Directory Project</name>
+<url>http://incubator.apache.org/directory</url>
+<logo>http://incubator.apache.org/directory/images/apache-directory-logo.png</logo>
+
+<organization>
+ <name>Apache Incubator</name>
+ <url>http://incubator.apache.org</url>
+ <logo>http://incubator.apache.org/directory/images/apache-incubator-logo.png</logo>
+</organization>
+ </source>
+
+ <p>
+ The first stanza above should set the alt hints and link for the
+ project logo banner in the upper right hand corner using the following
+ graphic:
+ </p>
+
+ <img src="http://incubator.apache.org/directory/images/apache-directory-logo.png"/>
+
+ <p>
+ The second stanza sets the organization logo which for now is the
+ Apache Incubator. The organization logo appears at the upper right
+ hand side, links to the incubator's main site and hold's alt hints
+ for the incubator. The following graphic will appear for this logo:
+ </p>
+
+ <img src="http://incubator.apache.org/directory/images/apache-incubator-logo.png"/>
+ </subsection>
+
+ <subsection name="Navigations">
+ <p>
+ Maintaining a consistant look and feel means perserving the top level
+ site's menus. To do this you'll need to work with the same navigation
+ and this requires the following navigation.xml template:
+ </p>
+
+ <source>
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project>
+
+ <title>Apache Directory Project</title>
+
+ <body>
+
+ <links>
+ <item name="Apache" href="http://apache.org/"/>
+ <item name="Directory" href="../../index.html"/>
+ <item name="Eve" href="/index.html"/>
+ <item name="LDAP" href="../ldap/index.html"/>
+ <item name="Naming" href="../naming/index.html"/>
+ <item name="Janus" href="../janus/index.html"/>
+ <item name="Snickers" href="../snickers/index.html"/>
+ <item name="Sitedocs" href="../sitedocs/index.html"/>
+ </links>
+
+ <menu name="About Directory">
+ <item name="Overview" href="../../index.html"/>
+ <item name="Community" href="../../community/index.html"/>
+ <item name="Latest News" href="../../news.html"/>
+ <item name="Subprojects" href="../../subprojects/index.html">
+ <item name="Eve" href="/index.html"/>
+ <item name="LDAP" href="../ldap/index.html"/>
+ <item name="Janus" href="../janus/index.html"/>
+ <item name="Naming" href="../naming/index.html"/>
+ <item name="Snickers" href="../snickers/index.html"/>
+ <item name="Sitedocs" href="../sitedocs/index.html"/>
+ </item>
+ <item name="Documentation" href="../../doc/index.html"/>
+ </menu>
+
+ <menu name="Resources">
+ <item name="IRC" href="../../irc.html"/>
+ <item name="Jira" href=
+ "http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
+ <item name="Wiki" href="http://wiki.apache.org/directory"/>
+ <item name="Lists" href="../../mailing-lists.html"/>
+ <item name="License" href="../../license.html"/>
+ <item name="Sandbox" href="../../sandbox/index.html"/>
+ <item name="Downloads" href="../../download.cgi"/>
+ <item name="Subversion" href="../../svn.html"/>
+ <item name="Related Projects" href="../../related/index.html"/>
+ </menu>
+
+ </body>
+
+</project>
+ </source>
+
+ <p>
+ You can download this navigation template from
+ <a href="./nav-template.txt">here</a>. Remember you take this
+ template and expand one of the subproject nodes to the number and kind
+ of subitems of your choosing by breaking up into a two part tag and
+ embedding more items within. For example this is how the Eve
+ subproject site navigation is structured:
+ </p>
+
+ <source>
+ <item name="Eve" href="/index.html">
+ <item name="Design" href="/design/index.html"/>
+ <item name="Features" href="/features.html"/>
+ <item name="Backend" href="/backend/index.html"/>
+ <item name="Frontend" href="/frontend/index.html"/>
+ </item>
+ </source>
+ </subsection>
+
+ <subsection name="maven.xml">
+ <p>
+ Some scripting is required within the maven jelly scripting file for
+ your project. As you may already know this maven.xml file sits at
+ your projects top level directory along side your project.xml file.
+ Here's what you have to add to it:
+ </p>
+
+ <source>
+ <postGoal name="site">
+ <attainGoal name="subproject:collectdocs"/>
+ </postGoal>
+
+ <goal name="subproject:collectdocs">
+ <ant:copy toDir="../../../sitedocs/trunk/sitedocs/target/docs/subprojects/[subproject-name]">
+ <ant:fileSet dir="${basedir}/target/docs">
+ <ant:include name="**"/>
+ </ant:fileSet>
+ </ant:copy>
+ </goal>
+ </source>
+
+ <p>
+ This Jelly code sets up a new goal to execute after the subproject's
+ site has been built. It is called <em>subproject:collectdocs</em>.
+ Make sure you edit the toDir attribute value on the <ant:copy>
+ tag to use your subprojects destination directory. It will copy the
+ generated output of your subproject site build under the sitedocs
+ directory in the respective position.
+ </p>
+ </subsection>
+
+ <subsection name="Links">
+ <p>
+ Check out the section talking about links. All we do here is let you
+ know that you have to keep in mind the distance between the TLP site
+ documents and your subproject's site in the final deployed state.
+ Basically you have <b>subprojects/[supproject-name]</b> in the way.
+ That means two relative levels up to get to TLP resources while the
+ resources local to the project are still accessed as relative
+ resources.
+ </p>
+
+ <p>
+ If you have questions just take a look at the links section and the
+ links in the navigation template above. If you still have questions
+ use trial and error until you develope a feel for it. Just generate
+ the document and see if it works locally by pointing a browser to it.
+ If you still need help post to the list.
+ </p>
+ </subsection>
+ </section>
+
+ <section name="Deploying Site and Subprojects">
+ <subsection name="Incubator Site">
+ <p>
+ The entire Apache Incubator site is kept within CVS. This includes
+ generated files. There has to be a good Apache Incubator resource
+ for this in existance that explains how it is all organized. Until
+ I figure that out just follow along.
+ </p>
+
+ <p>
+ Currently as a podling the Directory Project's resources are managed
+ under the Apache Incubator. The website is no exception. The
+ specific incubator module used is the <b>incubator-directory</b> CVS
+ module. I check it out like so:
+ </p>
+
+ <source>
+cvs -d :ext:akarasulu@cvs.apache.org:/home/cvs co incubator-directory
+ </source>
+
+ <p>
+ This module contains a content directory: <b>www</b>. The final
+ content under <b>www</b> is served up by the Apache servers. The
+ module's <b>www</b> folder is checked out daily into the following
+ directory on minotaur.apache.org:
+ <b>/www/incubator.apache.org/directory</b>
+ </p>
+
+ <p>
+ So all we have to do is generate the site out of our subversion
+ working directory and copy the Maven generated content into the
+ <b>www</b> folder of the CVS working copy for the incubator-directory
+ CVS module. That's a mouth full.
+ </p>
+
+ <p>
+ Once the generated content is copied, the changes are committed. Then
+ deployers should ssh into minotaur and cd to the
+ <b>/www/incubator.apache.org/directory</b> to do an update like so:
+ </p>
+
+ <source>
+cd /www/incubator.apache.org/directory
+cvs update -d
+ </source>
+
+ <p>
+ Everyone within our team has access to this area. Anyone can deploy
+ the entire site or just a part of it this way. It's a pretty neat
+ setup and works well.
+ </p>
+
+ </subsection>
+
+ <subsection name="Building Top Level Project Site">
+ <p>
+ Keep in mind that the subprojects contain their own documentation.
+ They hook into the TLP Site. The sitedocs project manages the TLP
+ site shell. Any documentation that is not specific to a subproject
+ goes here.
+ </p>
+
+ <p>
+ Building the top level project site is really simple. You checkout
+ the sitedocs trunk form the subversion repository. Add, delete or
+ make changes to the xdocs that reside under the <b>xdocs</b> folder.
+ Once the changes are made run:
+ </p>
+
+ <source>
+maven site
+ </source>
+
+ <p>
+ This will generate the TLP site right under <b>target/docs</b>.
+ This does not generate the subproject content. To do this you'll
+ have to build the subproject documentation by using the same command
+ on the respective subproject. If all subprojects are configured as
+ documented here in the subproject integration section above then the
+ subproject build should copy the generated subproject documents over
+ to the respective <b>target/docs/subprojects/[subproject]</b> output
+ folder of the sitedocs module.
+ </p>
+
+ <p>
+ If you're changes are to the TLP only without changes to the
+ subprojects then there is no need to build any subproject sites. If
+ you want to deploy one or more subproject site changes then go ahead
+ and build the subproject site for every subproject module. All the
+ results collect under the <b>sitedocs/target/docs</b> folder.
+ </p>
+
+ <p>
+ The contents of the <b>sitedocs/target/docs</b> folder is what is
+ copied over into the <b>incubator-directory/www</b> folder and
+ committed into CVS.
+ </p>
+ </subsection>
</section>
<section name="Maven Howto">
Added: incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/nav-template.txt
==============================================================================
--- (empty file)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/nav-template.txt Tue Feb 3 20:14:55 2004
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project>
+
+ <title>Apache Directory Project</title>
+
+ <body>
+
+ <links>
+ <item name="Apache" href="http://apache.org/"/>
+ <item name="Directory" href="../../index.html"/>
+ <item name="Eve" href="/index.html"/>
+ <item name="LDAP" href="../ldap/index.html"/>
+ <item name="Naming" href="../naming/index.html"/>
+ <item name="Janus" href="../janus/index.html"/>
+ <item name="Snickers" href="../snickers/index.html"/>
+ <item name="Sitedocs" href="../sitedocs/index.html"/>
+ </links>
+
+ <menu name="About Directory">
+ <item name="Overview" href="../../index.html"/>
+ <item name="Community" href="../../community/index.html"/>
+ <item name="Latest News" href="../../news.html"/>
+ <item name="Subprojects" href="../../subprojects/index.html">
+ <item name="Eve" href="/index.html"/>
+ <item name="LDAP" href="../ldap/index.html"/>
+ <item name="Janus" href="../janus/index.html"/>
+ <item name="Naming" href="../naming/index.html"/>
+ <item name="Snickers" href="../snickers/index.html"/>
+ <item name="Sitedocs" href="../sitedocs/index.html"/>
+ </item>
+ <item name="Documentation" href="../../doc/index.html"/>
+ </menu>
+
+ <menu name="Resources">
+ <item name="IRC" href="../../irc.html"/>
+ <item name="Jira" href=
+ "http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
+ <item name="Wiki" href="http://wiki.apache.org/directory"/>
+ <item name="Lists" href="../../mailing-lists.html"/>
+ <item name="License" href="../../license.html"/>
+ <item name="Sandbox" href="../../sandbox/index.html"/>
+ <item name="Downloads" href="../../download.cgi"/>
+ <item name="Subversion" href="../../svn.html"/>
+ <item name="Related Projects" href="../../related/index.html"/>
+ </menu>
+
+ </body>
+
+</project>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/navigation.xml Tue Feb 3 20:14:55 2004
@@ -21,7 +21,7 @@
<item name="Overview" href="/index.html"/>
<item name="Community" href="/community/index.html"/>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html">
+ <item name="Subprojects" href="/subprojects/index.html">
<item name="Eve" href="/subprojects/eve/index.html"/>
<item name="LDAP" href="/subprojects/ldap/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
@@ -33,6 +33,7 @@
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/snickers/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/snickers/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/snickers/navigation.xml Tue Feb 3 20:14:55 2004
@@ -21,7 +21,7 @@
<item name="Overview" href="/index.html"/>
<item name="Community" href="/community/index.html"/>
<item name="Latest News" href="/news.html"/>
- <item name="Sub-Projects" href="/subprojects/index.html">
+ <item name="Subprojects" href="/subprojects/index.html">
<item name="Eve" href="/subprojects/eve/index.html"/>
<item name="LDAP" href="/subprojects/ldap/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
@@ -33,6 +33,7 @@
</menu>
<menu name="Resources">
+ <item name="IRC" href="/irc.html"/>
<item name="Jira" href=
"http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
<item name="Wiki" href="http://wiki.apache.org/directory"/>