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/01 09:51:10 UTC
svn commit: rev 6405 - in incubator/directory/sitedocs/trunk/sitedocs/xdocs: . community community/history community/process community/who doc related sandbox subprojects subprojects/eve subprojects/janus subprojects/ldap subprojects/naming subprojects/sitedocs subprojects/snickers
Author: akarasulu
Date: Sun Feb 1 00:51:10 2004
New Revision: 6405
Added:
incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/java-ldap.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/ldapd-group.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/naming-commons.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/
incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/index.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/navigation.xml
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/navigation.xml
incubator/directory/sitedocs/trunk/sitedocs/xdocs/news.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/eve/navigation.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/snickers/navigation.xml
Log:
added sitedoc documentation so subprojects can be setup
Added: incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/java-ldap.xml
==============================================================================
--- (empty file)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/java-ldap.xml Sun Feb 1 00:51:10 2004
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Apache Directory Project: History of Java and LDAP</title>
+ </properties>
+
+ <body>
+ <section name="History of Java and LDAP">
+ <p>
+ Coming soon ...
+ </p>
+ </section>
+ </body>
+</document>
+
\ No newline at end of file
Added: incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/ldapd-group.xml
==============================================================================
--- (empty file)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/ldapd-group.xml Sun Feb 1 00:51:10 2004
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Apache Directory Project: History of the LDAPd Group</title>
+ </properties>
+
+ <body>
+ <section name="History of the LDAPd Group">
+ <p>
+ Coming soon ...
+ </p>
+ </section>
+ </body>
+</document>
+
\ No newline at end of file
Added: incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/naming-commons.xml
==============================================================================
--- (empty file)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/community/history/naming-commons.xml Sun Feb 1 00:51:10 2004
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Apache Directory Project: History of Naming Commons</title>
+ </properties>
+
+ <body>
+ <section name="History of Naming Commons">
+ <p>
+ Coming soon ...
+ </p>
+ </section>
+ </body>
+</document>
+
\ No newline at end of file
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 Sun Feb 1 00:51:10 2004
@@ -14,6 +14,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About 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 Sun Feb 1 00:51:10 2004
@@ -14,6 +14,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About 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 Sun Feb 1 00:51:10 2004
@@ -14,6 +14,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About 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 Sun Feb 1 00:51:10 2004
@@ -13,6 +13,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About 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 Sun Feb 1 00:51:10 2004
@@ -14,6 +14,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About Directory">
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 Sun Feb 1 00:51:10 2004
@@ -14,6 +14,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About Directory">
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/news.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/news.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/news.xml Sun Feb 1 00:51:10 2004
@@ -18,7 +18,9 @@
Apache Directory TLP upon matriculation from the incubator.
</p>
<p>
- Thanks to all those that made it happen!
+ The original proposal can be found <a href=
+ "http://nagoya.apache.org/wiki/apachewiki.cgi?ApacheDirectoryProject">
+ here</a>. Thanks to all those that made it happen!
</p>
</subsection>
</section>
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 Sun Feb 1 00:51:10 2004
@@ -14,6 +14,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About 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 Sun Feb 1 00:51:10 2004
@@ -14,6 +14,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About Directory">
Modified: incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/eve/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/eve/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/eve/navigation.xml Sun Feb 1 00:51:10 2004
@@ -14,6 +14,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About Directory">
@@ -26,6 +27,7 @@
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</item>
<item name="Documentation" href="/doc/index.html"/>
</menu>
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 Sun Feb 1 00:51:10 2004
@@ -14,6 +14,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About Directory">
@@ -26,6 +27,7 @@
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</item>
<item name="Documentation" href="/doc/index.html"/>
</menu>
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 Sun Feb 1 00:51:10 2004
@@ -14,6 +14,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About Directory">
@@ -26,6 +27,7 @@
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</item>
<item name="Documentation" href="/doc/index.html"/>
</menu>
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 Sun Feb 1 00:51:10 2004
@@ -14,6 +14,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About Directory">
@@ -26,6 +27,7 @@
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</item>
<item name="Documentation" href="/doc/index.html"/>
</menu>
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 Sun Feb 1 00:51:10 2004
@@ -26,6 +26,7 @@
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</item>
<item name="Documentation" href="/doc/index.html"/>
</menu>
Added: incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/index.xml
==============================================================================
--- (empty file)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/index.xml Sun Feb 1 00:51:10 2004
@@ -0,0 +1,122 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Apache Directory Project: Web Site Documentation</title>
+ </properties>
+
+ <body>
+ <section name="Overview">
+ <p>
+ This project documents what is to be the umbrella website for all
+ Directory Project Sub-Projects. There are a few rules and information
+ that is needed by Sub-Project developers in order to integrate/plugin
+ their Sub-Project documentation with this website.
+ </p>
+
+ <p>
+ We use maven and the xdoc format to manage site documents and site
+ generation. The layout for the top level site is managed here in this
+ project. This is a subproject area which is where subproject content
+ is deposited. In case this does not happen correctly some stubs have
+ been left in place of the subproject. Here's where we keep subproject
+ xdoc stubs:
+ </p>
+ <source>
+sitedocs/xdocs/subprjects
+ ./eve
+ ./ldap
+ ./janus
+ ./naming
+ ./snickers
+ ./sitedocs
+ </source>
+
+ <p>
+ Obviously, rather than use stubs, the sitedocs subproject area will
+ contain actual content which this page is part of. These directories
+ as mentioned before contain stubs. When the top level site is generated
+ the html created is deposited int the target/docs directory of the
+ sitedocs project directory here:
+ </p>
+
+ <source>directory/sitedocs/trunk/sitedocs/target/docs</source>
+
+ <p>
+ It is the reponsibility of subprojects to generate their own content
+ and copy it over to their appropriate directory within the subprojects
+ directory. The Eve subproject for example does this using a post goal
+ within the maven.xml project like so to copy its site documentation:
+ </p>
+
+ <source>
+ <postGoal name="site">
+ <attainGoal name="server:copy-images"/>
+ <attainGoal name="subproject:collectdocs"/>
+ </postGoal>
+
+ <goal name="subproject:collectdocs">
+ <copy toDir="../../../sitedocs/trunk/sitedocs/target/docs/subprojects/eve">
+ <fileSet dir="${basedir}/target/docs">
+ <include name="**"/>
+ </fileSet>
+ </copy>
+ </goal>
+ </source>
+
+ <p>
+ This however is not the only requirement. As we'll see to maintain
+ consistancy throughout the site subproject documentation needs to
+ manage links, manage the same navigations, set properties in maven
+ and its pom.
+ </p>
+ </section>
+
+ <section name="Links Howto">
+ <p>
+ All links to documents within the same subproject are relative to that
+ subproject. Links to resources outside the subproject must take into
+ account the relative position of the target directory the subproject's
+ generated content is copied into.
+ </p>
+
+ <p>
+ For example the 'directory' link in the sitedocs project is simply
+ '/index.html'. The same 'directory' line in the Eve subproject will
+ be '../../index.html'. This is because the Eve project's generated
+ content ultimately resides two directories deep with the sitedocs
+ project's document root here: './subprojects/eve'. It takes a
+ '../../' to get to the index.html that is the home page for the TLP
+ site.
+ </p>
+
+ <p>
+ Links to Apache, Directory, Eve, LDAP, Naming, Janus, Snickers and
+ Sitedocs must be maintained by all subprojects to keep the overall
+ site consistant.
+ </p>
+ </section>
+
+ <section name="Maven Howto">
+ <p>
+ Gotta add some of the logo stuff! And need to setup site.jsl.
+ </p>
+
+ <p>
+ These settings must be preserved to keep the site consistant.
+ </p>
+ </section>
+
+ <section name="Navigation Howto">
+ <p>
+ Navigation hyperlinks follow the same rules that govern the way links
+ are managed.
+ </p>
+ <p>
+ Again these settings must be preserved to keep the site consistant.
+ </p>
+ </section>
+
+ </body>
+</document>
+
Added: incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/navigation.xml
==============================================================================
--- (empty file)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/sitedocs/navigation.xml Sun Feb 1 00:51:10 2004
@@ -0,0 +1,49 @@
+<?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="/subprojects/eve/index.html"/>
+ <item name="LDAP" href="/subprojects/ldap/index.html"/>
+ <item name="Naming" href="/subprojects/naming/index.html"/>
+ <item name="Janus" href="/subprojects/janus/index.html"/>
+ <item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/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="Sub-Projects" 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"/>
+ <item name="Naming" href="/subprojects/naming/index.html"/>
+ <item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
+ </item>
+ <item name="Documentation" href="/doc/index.html"/>
+ </menu>
+
+ <menu name="Resources">
+ <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/snickers/navigation.xml
==============================================================================
--- incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/snickers/navigation.xml (original)
+++ incubator/directory/sitedocs/trunk/sitedocs/xdocs/subprojects/snickers/navigation.xml Sun Feb 1 00:51:10 2004
@@ -14,6 +14,7 @@
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</links>
<menu name="About Directory">
@@ -26,6 +27,7 @@
<item name="Janus" href="/subprojects/janus/index.html"/>
<item name="Naming" href="/subprojects/naming/index.html"/>
<item name="Snickers" href="/subprojects/snickers/index.html"/>
+ <item name="Sitedocs" href="/subprojects/sitedocs/index.html"/>
</item>
<item name="Documentation" href="/doc/index.html"/>
</menu>