diff options
| author | Brett Porter <brett@apache.org> | 2007-11-19 05:07:44 +0000 |
|---|---|---|
| committer | Brett Porter <brett@apache.org> | 2007-11-19 05:07:44 +0000 |
| commit | 6623369e12774da9c7acf7491390b8feba80a6d0 (patch) | |
| tree | b7751cf1fa672d36882f74c8d9a676da2941ec17 /archiva-site/src/site | |
| parent | 29b0fcbf82934c02195e934e510a63e87e7eba9f (diff) | |
| download | archiva-6623369e12774da9c7acf7491390b8feba80a6d0.tar.gz archiva-6623369e12774da9c7acf7491390b8feba80a6d0.zip | |
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
Diffstat (limited to 'archiva-site/src/site')
27 files changed, 75 insertions, 187 deletions
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/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/adminguide/quickstart.apt b/archiva-site/src/site/apt/quick-start.apt index c50b40b29..c50b40b29 100644 --- a/archiva-site/src/site/apt/adminguide/quickstart.apt +++ b/archiva-site/src/site/apt/quick-start.apt 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/webdav.apt b/archiva-site/src/site/apt/userguide/using-repository.apt index 398b06c19..0fff28b49 100644 --- a/archiva-site/src/site/apt/userguide/webdav.apt +++ b/archiva-site/src/site/apt/userguide/using-repository.apt @@ -1,8 +1,8 @@ ------ - WebDAV Features + Using as a Repository ------ -WebDAV Features +Using as a Repository :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 @@ </breadcrumbs> <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" /> + <item name="Quick Start" href="/quick-start.html" /> + <item name="Feature Tour" href="/tour/index.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> + <item name="Identifying an Artifact" href="/userguide/find-artifact.html" /> + <item name="Using as a repository" href="/userguide/using-repository.html" /> + <item name="Deploying to repository" href="/userguide/deploy.html" /> </menu> - <menu name="System Admin Guide"> + <menu name="Administrators Guide"> <item name="Structure of Archiva" href="/adminguide/structure.html" /> - <item name="Installing" href="/adminguide/installing.html" collapse="false"> + <item name="Installing" href="/adminguide/installing.html" collapse="true"> <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 name="Installing as a WAR" href="/adminguide/webapp.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="Databases" href="/adminguide/databases.html" /> + <item name="Security" href="/adminguide/security.html" collapse="true"> <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="Runtime Configuration" href="/adminguide/configuration.html" collapse="true"> <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="Configuration Files" href="/adminguide/configuration-files.html" /> <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 name="Customising Archiva"> + <item name="Write a Consumer Plugin" href="/customising/writing-consumers.html" /> </menu> <!-- to be removed later, once content has been shifted to permanent home --> diff --git a/archiva-site/src/site/xdoc/index.xml b/archiva-site/src/site/xdoc/index.xml index 89ac53f57..fe3075abf 100644 --- a/archiva-site/src/site/xdoc/index.xml +++ b/archiva-site/src/site/xdoc/index.xml @@ -39,8 +39,15 @@ maintenance on your repositories. </p> -<!-- TODO: link to other content - quick start, guides, etc --> - +<!-- TODO: improve appearance of these links --> +<p> + To get started with Archiva, read the following documentation: +</p> +<ul> +<li><a href="/quick-start.html">A Quick Getting Started Guide</a></li> +<li><a href="/userguide/index.html">User's Guide</a></li> +<li><a href="/adminguide/index.html">Administrator's Guide</a></li> +</ul> <!-- TODO: move to the feature tour <ul> |