[MRM-1407] documentation for staging & merging repositories

submitted by Patti Arachchige Eshan Sudharaka

additional changes made:
o moved to staging repos doc to admin guide instead of user guide
o added a few lines and fixed typos in the staging doc

git-svn-id: https://svn.apache.org/repos/asf/archiva/branches/archiva-MRM-980@985674 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/archiva-docs/src/site/apt/adminguide/configuration.apt b/archiva-docs/src/site/apt/adminguide/configuration.apt
index 346f7f2061e59427d1df5dbc337cbc75c47b43dd..11e5192db03ba8828dc5f1115cf3f9ff4f116ecb 100644 (file)
--- a/archiva-docs/src/site/apt/adminguide/configuration.apt
+++ b/archiva-docs/src/site/apt/adminguide/configuration.apt
@@ -18,5 +18,7 @@ Runtime Configuration of Apache Archiva
 
     * {{{consumers.html} Configuring repository scanning and consumers}}
 
+    * {{{staging-repositories.html} Staging and merging repositories}}
+
     []
 

diff --git a/archiva-docs/src/site/apt/adminguide/staging-repositories.apt b/archiva-docs/src/site/apt/adminguide/staging-repositories.apt
new file mode 100644 (file)
index 0000000..8846edb
--- /dev/null
+++ b/archiva-docs/src/site/apt/adminguide/staging-repositories.apt
@@ -0,0 +1,51 @@
+ ------
+ Staging Repositories
+ ------
+
+Staging Repositories
+
+  Starting with Archiva 1.4, staging repositories are supported. A staging repository is a repository you use 
+  to stage a release (while it undergoes testing and voting), before the release is officially announced and published
+  to a releases repository where users can obtain it.
+
+  With the support of staging repositories comes the ability to merge repositories from the web UI. By merging, we mean
+  promoting the artifacts in the staging repository to the managed repository. In the current
+  implementation, a user can create and attach a staging repository to an existing managed repository. An attached 
+  staging repository is a shadow of its managed repository, meaning they would have the same configuration.
+
+  We append <<-stage>> to the managed repository's ID to identify its staging repository. For example, repository
+  <<<test>>> would have a staging repository called <<<test-stage>>>.
+
+  If you're creating a new managed repository, just tick the <<<Create stage repository>>> check box. Otherwise, if
+  you already have an existing managed repository and you want to create a staging repository, just edit the managed
+  repository's configuration and tick the <<<Create stage repository>>> checkbox, then save the configuration. A staging
+  repository will be created in the same directory as the managed repository.
+
+  <<<Note:>>> By un-ticking the <<<Create stage repository>>> checkbox, the user can delete the attached staging
+  repository. If the managed repository is deleted, then its attached staging repository is also deleted.
+
+  The <<<snapshots>>> and <<<internal>>> repositories configured in Archiva by default, are not configured with attached
+  staging repositories.
+
+* Merging Repositories
+
+  To merge or promote the artifacts in a staging repository to the managed repository, just click the <<<Merge>>> button
+  in the repository configuration page.
+
+[../images/repository-merge.png] Merge Button
+
+  Archiva will check for conflicting artifacts between the two repositories, and list them (if it finds conflicts).
+  The user will be asked to choose between two actions:
+
+  [[1]] <<<Merge All>>> - ignore all conflicting artifacts and perform merging for all.
+
+  [[2]] <<<Merge With Skip>>> - skip all conflicting artifacts and merge only the non-conflicting ones.
+
+  []
+
+[../images/conflicting-artifacts.png] Merge Actions
+
+  In future, we plan to enhance this by allowing a user to select only specific artifacts to merge.
+
+
+

diff --git a/archiva-docs/src/site/resources/images/conflicting-artifacts.png b/archiva-docs/src/site/resources/images/conflicting-artifacts.png
new file mode 100755 (executable)
index 0000000..ac53c3a
Binary files /dev/null and b/archiva-docs/src/site/resources/images/conflicting-artifacts.png differ

diff --git a/archiva-docs/src/site/resources/images/repository-merge.png b/archiva-docs/src/site/resources/images/repository-merge.png
new file mode 100755 (executable)
index 0000000..3c41b80
Binary files /dev/null and b/archiva-docs/src/site/resources/images/repository-merge.png differ

diff --git a/archiva-docs/src/site/site.xml b/archiva-docs/src/site/site.xml
index 7508491e35c2840a8f7f3b40ede31743dd91d2e6..a04cf283208118dc504eadef814267ece0902a86 100644 (file)
--- a/archiva-docs/src/site/site.xml
+++ b/archiva-docs/src/site/site.xml
@@ -71,6 +71,7 @@
         <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 name="Staging Repositories"      href="/adminguide/staging-repositories.html"/>
       </item>
       <item name="Configuration Files"       href="/adminguide/configuration-files.html" />
       <item name="Log Files"                 href="/adminguide/logging.html" collapse="true">