[MRM-619]

-standardized Users Guide
-added Scanning a Database section in Repositories page

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

diff --git a/archiva-docs/src/site/apt/adminguide/repositories.apt b/archiva-docs/src/site/apt/adminguide/repositories.apt
index 56cc5ae2f15dfc486c5839997abf28763c0dd499..e21bddeb5eba13e71ef2fd1e09662830bb0c113b 100644 (file)
--- a/archiva-docs/src/site/apt/adminguide/repositories.apt
+++ b/archiva-docs/src/site/apt/adminguide/repositories.apt
@@ -108,7 +108,7 @@ http://[URL TO ARCHIVA]/repository/[REPOSITORY ID] (e.g. http://localhost:8080/a
   Repository scan can be executed on schedule or it can be explicitly executed by clicking the 'Scan Repository Now' button in 
   the repositories page. For every artifact found by the repository scanner, processing is done on this artifact by different
   consumers. Examples of the processing done are: indexing, repository purge and database update. Details about consumers are 
-  available in the Consumers page.
+  available in the {{{consumers.html} Consumers}} page.
 
 * Repository Purge
 
@@ -163,4 +163,13 @@ Artifacts in the repository:
   artifact-x-20070113.034619-3.pom, artifact-x-20070203.028902-4.jar and artifact-x-20070203.028902-4.pom will be retained 
   in the repository. The oldest snapshots will be deleted maintaining only a number of snapshots equivalent to the set 
   retention count. 
-               
\ No newline at end of file
+
+* Scanning a Database
+
+  Another scanning process also occurs in Archiva, the database scanning. Same as with repository scanning,
+  it can also be executed on schedule or explicitly. This can be configured in the 'Database' page, via the 'Database -
+  Unprocessed Artifacts Scanning' section.
+
+  It is essential that the database scan occur after the repo scan as this is where the pom information of the artifacts in
+  the database will be processed by the consumers and in turn, added to the database (as ArchivaProjectModel objects). For
+  more details about the different database consumers, please see the {{{consumers.html} Consumers}} page.
\ No newline at end of file

diff --git a/archiva-docs/src/site/apt/index.apt b/archiva-docs/src/site/apt/index.apt
index 02340d98974918bbd2df97d0452c6e78a5cc0b12..3ede682c3a31468ea463d50f1521394626f9089b 100644 (file)
--- a/archiva-docs/src/site/apt/index.apt
+++ b/archiva-docs/src/site/apt/index.apt
@@ -16,8 +16,8 @@
    
     * {{{quick-start.html} A Quick Getting Started Guide}}
 
-    * {{{userguide/index.html} User's Guide}}
+    * {{{userguide/index.html} Users Guide}}
 
-    * {{{adminguide/index.html} Administrator's Guide}}
+    * {{{adminguide/index.html} Administrators Guide}}
 
     []

diff --git a/archiva-docs/src/site/apt/userguide/index.apt b/archiva-docs/src/site/apt/userguide/index.apt
index 039b9b218e039a5f315e5aceb80caeca2c85e318..a41234d72f3fb5dae473085602902fd197c5d49f 100644 (file)
--- a/archiva-docs/src/site/apt/userguide/index.apt
+++ b/archiva-docs/src/site/apt/userguide/index.apt
@@ -1,8 +1,8 @@
  ------
- User Guide
+ Users Guide
  ------
 
-User Guide
+Users Guide
 
   Welcome to the Archiva user's guide. Getting to know and use Archiva is very simple - please select one of the following documents to learn how to use
   Archiva quickly.

diff --git a/archiva-docs/src/site/site.xml b/archiva-docs/src/site/site.xml
index 5518d18e615f8a33a9e3ad80da585cf1d9c532d4..6ffc35a2d205d157413edf8db59b9bd65216362c 100644 (file)
--- a/archiva-docs/src/site/site.xml
+++ b/archiva-docs/src/site/site.xml
@@ -61,6 +61,7 @@
         <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="Legacy (Maven 1) Support"         href="/adminguide/legacy.html" />        
         <item name="Consumers"               href="/adminguide/consumers.html" />
       </item>
       <item name="Configuration Files"       href="/adminguide/configuration-files.html" />