From: Brett Porter
Date: Mon, 19 Nov 2007 05:07:44 +0000 (+0000)
Subject: rationalise the navigation based on my email to archiva-dev@
X-Git-Tag: archiva-1.0~41
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=6623369e12774da9c7acf7491390b8feba80a6d0;p=archiva.git
rationalise the navigation based on my email to archiva-dev@
git-svn-id: https://svn.apache.org/repos/asf/maven/archiva/trunk@596203 13f79535-47bb-0310-9956-ffa450edef68
---
diff --git a/archiva-site/src/site/apt/adminguide/configuration-files.apt b/archiva-site/src/site/apt/adminguide/configuration-files.apt
new file mode 100644
index 000000000..8f9518389
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/configuration-files.apt
@@ -0,0 +1,8 @@
+ ------
+ Configuration Files of Apache Archiva
+ ------
+
+Configuration Files of 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
index 781cb52cd..b1e001231 100644
--- a/archiva-site/src/site/apt/adminguide/databases.apt
+++ b/archiva-site/src/site/apt/adminguide/databases.apt
@@ -6,3 +6,6 @@ Apache Archiva Databases
:STUB: This is a documentation stub.
+~~TODO: give general information on configuration for an external database
+~~TODO: use mysql or external derby as an example
+~~TODO: link to wiki location that does others
diff --git a/archiva-site/src/site/apt/adminguide/derby.apt b/archiva-site/src/site/apt/adminguide/derby.apt
deleted file mode 100644
index de3a21963..000000000
--- a/archiva-site/src/site/apt/adminguide/derby.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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
deleted file mode 100644
index 036741916..000000000
--- a/archiva-site/src/site/apt/adminguide/geronimo.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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/installing.apt b/archiva-site/src/site/apt/adminguide/installing.apt
index 0260a4c9c..4005854f6 100644
--- a/archiva-site/src/site/apt/adminguide/installing.apt
+++ b/archiva-site/src/site/apt/adminguide/installing.apt
@@ -6,3 +6,4 @@ Installing Apache Archiva
:STUB: This is a documentation stub.
+~~TODO: ensure upgrading is covered - does it need to be a separate doc
diff --git a/archiva-site/src/site/apt/adminguide/jetty.apt b/archiva-site/src/site/apt/adminguide/jetty.apt
deleted file mode 100644
index 5c31c31a2..000000000
--- a/archiva-site/src/site/apt/adminguide/jetty.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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/mysql.apt b/archiva-site/src/site/apt/adminguide/mysql.apt
deleted file mode 100644
index 58c619692..000000000
--- a/archiva-site/src/site/apt/adminguide/mysql.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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/postgres.apt b/archiva-site/src/site/apt/adminguide/postgres.apt
deleted file mode 100644
index 28401f3ba..000000000
--- a/archiva-site/src/site/apt/adminguide/postgres.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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/quickstart.apt b/archiva-site/src/site/apt/adminguide/quickstart.apt
deleted file mode 100644
index c50b40b29..000000000
--- a/archiva-site/src/site/apt/adminguide/quickstart.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Quick Start
- ------
-
-Quick Start
-
- :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
deleted file mode 100644
index 05a431502..000000000
--- a/archiva-site/src/site/apt/adminguide/repository-sync.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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/standalone.apt b/archiva-site/src/site/apt/adminguide/standalone.apt
index 275bf4107..85ea30a29 100644
--- a/archiva-site/src/site/apt/adminguide/standalone.apt
+++ b/archiva-site/src/site/apt/adminguide/standalone.apt
@@ -6,3 +6,6 @@ Installing Standalone Distribution of Apache Archiva
:STUB: This is a documentation stub.
+~~TODO: link to quick start as it covers the most basic scenario
+~~TODO: ensure to refer to advanced configuration options, such as PLEXUS_BASE
+
diff --git a/archiva-site/src/site/apt/adminguide/tomcat.apt b/archiva-site/src/site/apt/adminguide/tomcat.apt
deleted file mode 100644
index 07c5d0759..000000000
--- a/archiva-site/src/site/apt/adminguide/tomcat.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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/webapp.apt b/archiva-site/src/site/apt/adminguide/webapp.apt
new file mode 100644
index 000000000..8dc32a6a5
--- /dev/null
+++ b/archiva-site/src/site/apt/adminguide/webapp.apt
@@ -0,0 +1,11 @@
+ ------
+ Installing Apache Archiva as a Web Application
+ ------
+
+Installing Apache Archiva as a Web Application
+
+ :STUB: This is a documentation stub.
+
+~~TODO: show example using Tomcat 6.
+~~TODO: link to wiki location for other application servers
+
diff --git a/archiva-site/src/site/apt/adminguide/webdav.apt b/archiva-site/src/site/apt/adminguide/webdav.apt
deleted file mode 100644
index cf5002247..000000000
--- a/archiva-site/src/site/apt/adminguide/webdav.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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/customising/writing-consumer.apt b/archiva-site/src/site/apt/customising/writing-consumer.apt
new file mode 100644
index 000000000..e61e95666
--- /dev/null
+++ b/archiva-site/src/site/apt/customising/writing-consumer.apt
@@ -0,0 +1,8 @@
+ ------
+ Writing a Custom Repository Consumer
+ ------
+
+Writing a Custom Repository Consumer
+
+ :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/quick-start.apt b/archiva-site/src/site/apt/quick-start.apt
new file mode 100644
index 000000000..c50b40b29
--- /dev/null
+++ b/archiva-site/src/site/apt/quick-start.apt
@@ -0,0 +1,8 @@
+ ------
+ Quick Start
+ ------
+
+Quick Start
+
+ :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/repository-sync.apt b/archiva-site/src/site/apt/repository-sync.apt
deleted file mode 100644
index c9a3bd9ce..000000000
--- a/archiva-site/src/site/apt/repository-sync.apt
+++ /dev/null
@@ -1,29 +0,0 @@
- ------
- Repository Synchronization
- ------
- Maven Team
- ------
- 12 October 2006
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-
-Repository Synchronization
diff --git a/archiva-site/src/site/apt/userguide/deploy-ant.apt b/archiva-site/src/site/apt/userguide/deploy-ant.apt
deleted file mode 100644
index a027c89e6..000000000
--- a/archiva-site/src/site/apt/userguide/deploy-ant.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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
deleted file mode 100644
index 849a7d047..000000000
--- a/archiva-site/src/site/apt/userguide/deploy-maven1.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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
deleted file mode 100644
index 1cbfa9bf1..000000000
--- a/archiva-site/src/site/apt/userguide/deploy-maven2.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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/deploy.apt b/archiva-site/src/site/apt/userguide/deploy.apt
new file mode 100644
index 000000000..30fbbdb48
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/deploy.apt
@@ -0,0 +1,8 @@
+ ------
+ Deploying to Repository
+ ------
+
+Deploying to Repository
+
+ :STUB: This is a documentation stub.
+
diff --git a/archiva-site/src/site/apt/userguide/find-artifact.apt b/archiva-site/src/site/apt/userguide/find-artifact.apt
new file mode 100644
index 000000000..132636716
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/find-artifact.apt
@@ -0,0 +1,8 @@
+ ------
+ Identifying an Artifact
+ ------
+
+Identifying an Artifact
+
+ :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
deleted file mode 100644
index 7e2cb8096..000000000
--- a/archiva-site/src/site/apt/userguide/using-ivy.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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
deleted file mode 100644
index bd171597a..000000000
--- a/archiva-site/src/site/apt/userguide/using-maven1.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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
deleted file mode 100644
index 56660c996..000000000
--- a/archiva-site/src/site/apt/userguide/using-maven2.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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/using-repository.apt b/archiva-site/src/site/apt/userguide/using-repository.apt
new file mode 100644
index 000000000..0fff28b49
--- /dev/null
+++ b/archiva-site/src/site/apt/userguide/using-repository.apt
@@ -0,0 +1,8 @@
+ ------
+ Using as a Repository
+ ------
+
+Using as a 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
deleted file mode 100644
index 398b06c19..000000000
--- a/archiva-site/src/site/apt/userguide/webdav.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- 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 1e4f26323..0e50e9dd6 100644
--- a/archiva-site/src/site/site.xml
+++ b/archiva-site/src/site/site.xml
@@ -28,69 +28,41 @@
-
-
-
+
+
+ To get started with Archiva, read the following documentation:
+
+