From: Joakim Erdfelt <joakime@apache.org>
Date: Wed, 7 Nov 2007 05:57:22 +0000 (+0000)
Subject: Implementing Documentation Outline as discussed in archiva-dev mailing list.
X-Git-Tag: archiva-1.0-beta-4~12
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=f72ae8a302da90ef6e7a3b90bd9dda7f03495fa5;p=archiva.git

Implementing Documentation Outline as discussed in archiva-dev mailing list.
Adding documentation stubs for each topic.



git-svn-id: https://svn.apache.org/repos/asf/maven/archiva/trunk@592620 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/archiva-site/src/site/apt/adminguide/configuration.apt b/archiva-site/src/site/apt/adminguide/configuration.apt
new file mode 100644
index 000000000..990b1a810
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/configuration.apt
@@ -0,0 +1,8 @@
+ ------
+ Runtime Configuration of Apache Archiva
+ ------
+
+Runtime Configuration of Apache Archiva
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/consumers.apt b/archiva-site/src/site/apt/adminguide/consumers.apt
new file mode 100644
index 000000000..20be04b49
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/consumers.apt
@@ -0,0 +1,8 @@
+ ------
+ Understanding Consumers in Apache Archiva
+ ------
+
+Understanding Consumers in Apache Archiva
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/databases.apt b/archiva-site/src/site/apt/adminguide/databases.apt
new file mode 100644
index 000000000..781cb52cd
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/databases.apt
@@ -0,0 +1,8 @@
+ ------
+ Apache Archiva Databases
+ ------
+
+Apache Archiva Databases
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/derby.apt b/archiva-site/src/site/apt/adminguide/derby.apt
new file mode 100644
index 000000000..de3a21963
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/derby.apt
@@ -0,0 +1,8 @@
+ ------
+ Using Apache Archiva with Apache Derby SQL Database
+ ------
+
+Using Apache Archiva with Apache Derby SQL Database
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/geronimo.apt b/archiva-site/src/site/apt/adminguide/geronimo.apt
new file mode 100644
index 000000000..036741916
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/geronimo.apt
@@ -0,0 +1,8 @@
+ ------
+ Installing Apache Archiva on Geronimo
+ ------
+
+Installing Apache Archiva on Geronimo
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/index.apt b/archiva-site/src/site/apt/adminguide/index.apt
new file mode 100644
index 000000000..9f255f611
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/index.apt
@@ -0,0 +1,8 @@
+ ------
+ System Administrators Guide to Apache Archiva
+ ------
+
+System Administrators Guide to Apache Archiva
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/installing.apt b/archiva-site/src/site/apt/adminguide/installing.apt
new file mode 100644
index 000000000..0260a4c9c
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/installing.apt
@@ -0,0 +1,8 @@
+ ------
+ Installing Apache Archiva
+ ------
+
+Installing Apache Archiva
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/jetty.apt b/archiva-site/src/site/apt/adminguide/jetty.apt
new file mode 100644
index 000000000..5c31c31a2
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/jetty.apt
@@ -0,0 +1,8 @@
+ ------
+ Installing Apache Archiva on Jetty
+ ------
+
+Installing Apache Archiva on Jetty
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/ldap.apt b/archiva-site/src/site/apt/adminguide/ldap.apt
new file mode 100644
index 000000000..59ea2bd1a
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/ldap.apt
@@ -0,0 +1,8 @@
+ ------
+ Using Apache Archiva with LDAP
+ ------
+
+Using Apache Archiva with LDAP
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/mysql.apt b/archiva-site/src/site/apt/adminguide/mysql.apt
new file mode 100644
index 000000000..58c619692
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/mysql.apt
@@ -0,0 +1,8 @@
+ ------
+ Using Apache Archiva with MySQL SQL Database
+ ------
+
+Using Apache Archiva with MySQL SQL Database
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/network-proxies.apt b/archiva-site/src/site/apt/adminguide/network-proxies.apt
new file mode 100644
index 000000000..ba04fc4d6
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/network-proxies.apt
@@ -0,0 +1,8 @@
+ ------
+ Understanding Network Proxy Configuration of Apache Archiva
+ ------
+
+Understanding Network Proxy Configuration of Apache Archiva
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/postgres.apt b/archiva-site/src/site/apt/adminguide/postgres.apt
new file mode 100644
index 000000000..28401f3ba
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/postgres.apt
@@ -0,0 +1,8 @@
+ ------
+ Using Apache Archiva with PostgreSQL Database
+ ------
+
+Using Apache Archiva with PostgreSQL Database
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/proxy-connectors.apt b/archiva-site/src/site/apt/adminguide/proxy-connectors.apt
new file mode 100644
index 000000000..0502b0ed4
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/proxy-connectors.apt
@@ -0,0 +1,8 @@
+ ------
+ Understanding Proxy Connector Configuration of Apache Archiva
+ ------
+
+Understanding Proxy Connector Configuration of Apache Archiva
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/quickstart.apt b/archiva-site/src/site/apt/adminguide/quickstart.apt
new file mode 100644
index 000000000..c50b40b29
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/quickstart.apt
@@ -0,0 +1,8 @@
+ ------
+ Quick Start
+ ------
+
+Quick Start
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/reports.apt b/archiva-site/src/site/apt/adminguide/reports.apt
new file mode 100644
index 000000000..71103e633
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/reports.apt
@@ -0,0 +1,8 @@
+ ------
+ Making the most of Reporting in Apache Archiva
+ ------
+
+Making the most of Reporting in Apache Archiva
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/repositories.apt b/archiva-site/src/site/apt/adminguide/repositories.apt
new file mode 100644
index 000000000..201bb7edc
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/repositories.apt
@@ -0,0 +1,8 @@
+ ------
+ Understanding Repository Configuration of Apache Archiva
+ ------
+
+Understanding Repository Configuration of Apache Archiva
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/repository-sync.apt b/archiva-site/src/site/apt/adminguide/repository-sync.apt
new file mode 100644
index 000000000..05a431502
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/repository-sync.apt
@@ -0,0 +1,8 @@
+ ------
+ Repository Sync and Apache Archiva
+ ------
+
+Repository Sync and Apache Archiva
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/roles.apt b/archiva-site/src/site/apt/adminguide/roles.apt
new file mode 100644
index 000000000..962303204
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/roles.apt
@@ -0,0 +1,8 @@
+ ------
+ Understanding Apache Archiva Security Roles
+ ------
+
+Understanding Apache Archiva Security Roles
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/security.apt b/archiva-site/src/site/apt/adminguide/security.apt
new file mode 100644
index 000000000..33770e4b0
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/security.apt
@@ -0,0 +1,8 @@
+ ------
+ Understanding Apache Archiva Security
+ ------
+
+Understanding Apache Archiva Security
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/standalone.apt b/archiva-site/src/site/apt/adminguide/standalone.apt
new file mode 100644
index 000000000..275bf4107
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/standalone.apt
@@ -0,0 +1,8 @@
+ ------
+ Installing Standalone Distribution of Apache Archiva
+ ------
+
+Installing Standalone Distribution of Apache Archiva
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/structure.apt b/archiva-site/src/site/apt/adminguide/structure.apt
new file mode 100644
index 000000000..8e672a9f7
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/structure.apt
@@ -0,0 +1,8 @@
+ ------
+ Structure of Apache Archiva
+ ------
+
+Structure of Apache Archiva
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/tomcat.apt b/archiva-site/src/site/apt/adminguide/tomcat.apt
new file mode 100644
index 000000000..07c5d0759
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/tomcat.apt
@@ -0,0 +1,8 @@
+ ------
+ Installing Apache Archiva on Tomcat
+ ------
+
+Installing Apache Archiva on Tomcat
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/adminguide/webdav.apt b/archiva-site/src/site/apt/adminguide/webdav.apt
new file mode 100644
index 000000000..cf5002247
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/webdav.apt
@@ -0,0 +1,8 @@
+ ------
+ The WebDAV Server in Apache Archiva
+ ------
+
+The WebDAV Server in Apache Archiva
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/userguide/browsing.apt b/archiva-site/src/site/apt/userguide/browsing.apt
new file mode 100644
index 000000000..cf4e4708f
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/browsing.apt
@@ -0,0 +1,8 @@
+ ------
+ Browsing
+ ------
+
+Browsing
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/userguide/deploy-ant.apt b/archiva-site/src/site/apt/userguide/deploy-ant.apt
new file mode 100644
index 000000000..a027c89e6
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/deploy-ant.apt
@@ -0,0 +1,8 @@
+ ------
+ Deploying to Repository using Ant
+ ------
+
+Deploying to Repository using Ant
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/userguide/deploy-maven1.apt b/archiva-site/src/site/apt/userguide/deploy-maven1.apt
new file mode 100644
index 000000000..849a7d047
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/deploy-maven1.apt
@@ -0,0 +1,8 @@
+ ------
+ Deploying to Repository using Maven 1
+ ------
+
+Deploying to Repository using Maven 1
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/userguide/deploy-maven2.apt b/archiva-site/src/site/apt/userguide/deploy-maven2.apt
new file mode 100644
index 000000000..1cbfa9bf1
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/deploy-maven2.apt
@@ -0,0 +1,8 @@
+ ------
+ Deploying to Repository using Maven 2
+ ------
+
+Deploying to Repository using Maven 2
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/userguide/index.apt b/archiva-site/src/site/apt/userguide/index.apt
new file mode 100644
index 000000000..58ef923d2
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/index.apt
@@ -0,0 +1,8 @@
+ ------
+ User Guide
+ ------
+
+User Guide
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/userguide/searching.apt b/archiva-site/src/site/apt/userguide/searching.apt
new file mode 100644
index 000000000..dd1cf04ed
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/searching.apt
@@ -0,0 +1,8 @@
+ ------
+ Searching
+ ------
+
+Searching
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/userguide/using-ivy.apt b/archiva-site/src/site/apt/userguide/using-ivy.apt
new file mode 100644
index 000000000..7e2cb8096
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/using-ivy.apt
@@ -0,0 +1,8 @@
+ ------
+ Using Repository as an Apache Ivy Repository
+ ------
+
+Using Repository as an Apache Ivy Repository
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/userguide/using-maven1.apt b/archiva-site/src/site/apt/userguide/using-maven1.apt
new file mode 100644
index 000000000..bd171597a
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/using-maven1.apt
@@ -0,0 +1,8 @@
+ ------
+ Using Repository as a Apache Maven 1 Repository
+ ------
+
+Using Repository as a Apache Maven 1 Repository
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/userguide/using-maven2.apt b/archiva-site/src/site/apt/userguide/using-maven2.apt
new file mode 100644
index 000000000..56660c996
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/using-maven2.apt
@@ -0,0 +1,8 @@
+ ------
+ Using Repository as a Apache Maven 2 Repository
+ ------
+
+Using Repository as a Apache Maven 2 Repository
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/userguide/webdav.apt b/archiva-site/src/site/apt/userguide/webdav.apt
new file mode 100644
index 000000000..398b06c19
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/webdav.apt
@@ -0,0 +1,8 @@
+ ------
+ WebDAV Features
+ ------
+
+WebDAV Features
+
+  :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/site.xml b/archiva-site/src/site/site.xml
index d7167b3bc..44c6b2233 100644
--- a/archiva-site/src/site/site.xml
+++ b/archiva-site/src/site/site.xml
@@ -21,11 +21,79 @@
 <project>
   <body>
     <links>
-      <item name="Maven" href="http://maven.apache.org/"/>
+      <item name="Apache"     href="http://www.apache.org/"/>
+      <item name="Maven"      href="http://maven.apache.org/"/>
+      <item name="Continuum"  href="http://maven.apache.org/continuum/"/>
     </links>
 
-    <menu name="Documentation">
-      <item name="Welcome" href="/index.html"/>
+    <menu name="Introduction">
+      <item name="Welcome"      href="/index.html" />
+      <item name="License"      href="/license.html" /> <!-- Generated -->
+      <item name="Download"     href="/download.html" />
+      <item name="Quick Start"  href="/adminguide/quickstart.html" />
+    </menu>
+
+    <menu name="Users Guide">
+      <item name="Browsing"                  href="/userguide/browsing.html" />
+      <item name="Searching"                 href="/userguide/searching.html" />
+      <item name="WebDAV Features"           href="/userguide/webdav.html" />
+      <item name="Using Repository ..."      collapse="false">
+        <item name="As a Maven 2 repository" href="/userguide/using-maven2.html" />
+        <item name="As a Maven 1 repository" href="/userguide/using-maven1.html" />
+        <item name="As an Ivy repository"    href="/userguide/using-ivy.html" />
+      </item>
+      <item name="Deploying to Repository"   collapse="false">
+        <item name="Using Maven 2"           href="/userguide/deploy-maven2.html" />
+        <item name="Using Maven 1"           href="/userguide/deploy-maven1.html" />
+        <item name="Using Ant"               href="/userguide/deploy-ant.html" />
+      </item>
+    </menu>
+
+    <menu name="System Admin Guide">
+      <item name="Structure of Archiva"      href="/adminguide/structure.html" />
+      <item name="Installing"                href="/adminguide/installing.html" collapse="false">
+        <item name="Installing Standalone"   href="/adminguide/standalone.html" />
+        <item name="Installing on Jetty"     href="/adminguide/jetty.html" />
+        <item name="Installing on Tomcat"    href="/adminguide/tomcat.html" />
+        <item name="Installing on Geronimo"  href="/adminguide/geronimo.html" />
+      </item>
+      <item name="Databases"                 href="/adminguide/databases.html" collapse="false">
+        <item name="Embedded Derby DB"       href="/adminguide/derby.html" />
+        <item name="External MySQL"          href="/adminguide/mysql.html" />
+        <item name="External PostgreSQL"     href="/adminguide/postgres.html" />
+      </item>
+      <item name="Security"                  href="/adminguide/security.html" collapse="false">
+        <item name="Roles"                   href="/adminguide/roles.html" />
+        <item name="Using LDAP"              href="/adminguide/ldap.html" />
+      </item>
+      <item name="Runtime Configuration"     href="/adminguide/configuration.html" collapse="false">
+        <item name="Repositories"            href="/adminguide/repositories.html" />
+        <item name="Proxy Connectors"        href="/adminguide/proxy-connectors.html" />
+        <item name="Network Proxies"         href="/adminguide/network-proxies.html" />
+        <item name="Consumers"               href="/adminguide/consumers.html" />
+      </item>
+      <item name="Reports"                   href="/adminguide/reports.html" />
+      <item name="WebDAV Server"             href="/adminguide/webdav.html" />
+      <item name="Repository Synch"          href="/adminguide/repository-sync.html" />
+    </menu>
+
+    <menu name="Reference">
+      <item name="FAQ"                       href="http://docs.codehaus.org/display/MAVENUSER/Archiva+FAQ" />
+      <item name="Community"                 collapse="false">
+        <item name="How to Contribute"       href="/contributing.html" />
+        <item name="Development Team"        href="/team-list.html" />     <!-- Generated -->
+        <item name="Mailing Lists"           href="/mail-lists.html" />    <!-- Generated -->
+        <item name="Issue Tracking"          href="http://jira.codehaus.org/browse/MRM" />
+        <item name="Subversion Repository"   href="/source-repository.html" /> <!-- Generated -->
+      </item>
+      <item name="Building / Hacking"        href="/hacking/index.html" />
+      <item name="Java APIDoc (javadoc)"     href="/ref/1.0/apidoc/" />    <!-- Generated -->
+      <item name="Source Cross Reference"    href="/ref/1.0/xref/" />      <!-- Generated -->
+      <item name="Test Cross Reference"      href="/ref/1.0/test-xref/" /> <!-- Generated -->
+    </menu>
+
+    <!-- to be removed later, once content has been shifted to permanent home -->
+    <menu name="Old Menu (deprecated)">
       <item name="Getting Started" href="/guides/getting-started.html"/>
       <item name="FAQ" href="http://docs.codehaus.org/display/MAVENUSER/Archiva+FAQ"/>
       <item name="Maven Configuration" href="/guides/maven-configuration.html"/>
@@ -34,7 +102,11 @@
       <item name="Hacking Archiva" href="/hacking/index.html"/>
     </menu>
 
+    <!--
+    Current generated reports are always empty when executed in archiva-site
+    Prefer to add useful generated reports to sections above.
     <menu ref="reports" inherit="bottom"/>
+      -->
   </body>
   <skin>
     <groupId>org.apache.maven.skins</groupId>
@@ -42,7 +114,7 @@
   </skin>
   <publishDate format="dd MMM yyyy"/>
   <bannerLeft>
-    <name>Maven</name>
+    <name>Apache Maven</name>
     <src>http://maven.apache.org/images/apache-maven-project-2.png</src>
     <href>http://maven.apache.org/</href>
   </bannerLeft>