Author: oching
Date: Sun Mar 15 04:54:09 2009
New Revision: 754614
URL: http://svn.apache.org/viewvc?rev=754614&view=rev
Log:
[MRM-1099]
submitted by Lani Sara
o new documentation for Delete Artifact
o updates on deploy, browse, find and upload artifact docs
o made a few tweaks on the submitted patch
Added:
archiva/trunk/archiva-docs/src/site/apt/userguide/delete-artifact.apt
archiva/trunk/archiva-docs/src/site/resources/images/upload-artifact.jpg
(with props)
Modified:
archiva/trunk/archiva-docs/src/site/apt/userguide/browsing.apt
archiva/trunk/archiva-docs/src/site/apt/userguide/deploy.apt
archiva/trunk/archiva-docs/src/site/apt/userguide/find-artifact.apt
archiva/trunk/archiva-docs/src/site/site.xml
Modified: archiva/trunk/archiva-docs/src/site/apt/userguide/browsing.apt
URL:
http://svn.apache.org/viewvc/archiva/trunk/archiva-docs/src/site/apt/userguide/browsing.apt?rev=754614&r1=754613&r2=754614&view=diff
==============================================================================
--- archiva/trunk/archiva-docs/src/site/apt/userguide/browsing.apt (original)
+++ archiva/trunk/archiva-docs/src/site/apt/userguide/browsing.apt Sun Mar 15
04:54:09 2009
@@ -3,7 +3,7 @@
------
Maria Odea Ching
------
- 9 November 2007
+ 23 February 2009
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -43,28 +43,32 @@
* Artifact Info
- The Artifact Info page is divided into 5 views:
+ Items in the repositories are hyperlinked allowing you easy access to view
more information. By clicking on the Group ID or Artifact ID you will be taken
to the repository browser. The Artifact Info page is divided into six views:
- 1. Info. Basic information about the artifact is displayed here. These are
the groupId, artifactId, version and
+ 1. Info. Basic information about the artifact is displayed here. These are
the groupId, artifactId, version and
packaging. A dependency pom snippet is also available, which a user can
just copy and paste in a pom file
to declare the artifact as a dependency of the project.
2. Dependencies. The dependencies of the artifact will be listed here. The
user can easily navigate to a specific
- dependency by clicking on the groupId, artifactId or version link. The
scope of the dependency is also shown.
+ dependency by clicking on the groupId, artifactId, or version link. The
scope of the dependency is also shown.
- 3. Dependency Tree. The dependencies of the artifact are displayed in a
tree-like view, which can also be
+ 3. Dependency Tree. The dependencies of the artifact are displayed in a
tree-like view, which can also be
navigated.
4. Used By. Lists all the artifacts in the repository which use this
artifact.
5. Mailing Lists. The project mailing lists available in the artifact's pom
are displayed here.
+
+ 6. Download. Clicking on this link will download the artifact to your local
machine.
* Downloading Artifacts
Artifacts can be downloaded from the artifact info page. All files, except
for the metadata.xml files, that are
associated with the artifact are available in the download box. The size of
the files in bytes are displayed
at the right section of the download box.
-
+
+ Note: Upon downloading the artifact, you will be asked to enter your
username and password for the repository where the artifact will be
downloaded from. Only users with Global Repository Manager, Repository Manager,
or Repository Observer roles for that repository can download the artifact.
+
\ No newline at end of file
Added: archiva/trunk/archiva-docs/src/site/apt/userguide/delete-artifact.apt
URL:
http://svn.apache.org/viewvc/archiva/trunk/archiva-docs/src/site/apt/userguide/delete-artifact.apt?rev=754614&view=auto
==============================================================================
--- archiva/trunk/archiva-docs/src/site/apt/userguide/delete-artifact.apt
(added)
+++ archiva/trunk/archiva-docs/src/site/apt/userguide/delete-artifact.apt Sun
Mar 15 04:54:09 2009
@@ -0,0 +1,32 @@
+ ------
+Deleting an Artifact
+ ------
+25 February 2009
+ ------
+
+Deleting an Artifact
+
+ The Delete Artifact feature allows artifacts to be deleted from the managed
repositories.
+
+----
+ User must have a Repository Manager role to a repository to be able to
delete artifacts from it.
+----
+
+ To delete artifacts, perform these steps:
+
+ 1. From the left navigation menu, click <<Delete Artifact>>. This displays
the Delete Artifact page.
+
+ 2. Supply the necessary values for the following fields:
+
+ * Group Id: The group id of the artifact to be deleted.
+
+ * Artifact Id:The name of the artifact to be deleted.
+
+ * Version: The specific version of the artifact to be deleted.
+
+ * Repository Id: Select from the drop-down list the name of the managed
repository where the artifact is located.
+
+
+ 3. Click Submit.
+
+ If the artifact exists in the specified repository, it will be overwritten
and the metadata.xml will also be updated.
Modified: archiva/trunk/archiva-docs/src/site/apt/userguide/deploy.apt
URL:
http://svn.apache.org/viewvc/archiva/trunk/archiva-docs/src/site/apt/userguide/deploy.apt?rev=754614&r1=754613&r2=754614&view=diff
==============================================================================
--- archiva/trunk/archiva-docs/src/site/apt/userguide/deploy.apt (original)
+++ archiva/trunk/archiva-docs/src/site/apt/userguide/deploy.apt Sun Mar 15
04:54:09 2009
@@ -164,10 +164,13 @@
* Deploying via the {Web UI} Form
- The easiest way to deploy in the repository is via the Web UI form, which
can be accessed in the 'Upload Artifact' section.
+ The easiest way to deploy in the repository is via the Web UI form, which
can be accessed in the <<Upload Artifact>> section.
Just follow these steps:
- [[1]] Fill up the following required fields:
+ [[1]] In Archiva, click the <<Upload Artifact>> option in the left menu. You
should see a form similar to
+ the one at the end of this section.
+
+ [[2]] Fill in the following required fields:
* Group Id - the groupId of the artifact to be deployed.
@@ -181,16 +184,16 @@
[]
- [[2]] Select the repository you want to deploy to. Please note that if you
do not have write permission to the repository,
- you will not be allowed to deploy in it.
+ [[3]] Select the repository you want to deploy to. Please note that if you
do not have write permission to the repository,
+ you will not be allowed to deploy on it.
- [[3]] Now, if you want Archiva to generate a pom for the artifact, check the
Generate Maven 2 POM field.
+ [[4]] Now, if you want Archiva to generate a pom for the artifact, check the
Generate Maven 2 POM field.
(Right now, only Maven 2 poms can be generated.) Alternately, supply a POM
file to be deployed alongside the artifact.
- [[4]] Click Submit and a message will be displayed notifying you if the
upload/deployment was successful or not.
+ [[5]] Click Submit and a message will be displayed notifying you if the
upload/deployment was successful or not.
[]
-
+
These are the files that will be in your repository after deployment:
* artifact
@@ -202,5 +205,9 @@
* maven-metadata.xml.sha1 and maven-metadata.xml.md5 (these will be
generated for newly created maven-metadata.xml files, otherwise
they will just be updated)
+ []
+
+[../images/upload-artifact.jpg] Upload Artifact
+
~~TODO: information for Maven 1, ant tasks, ivy, etc.
Modified: archiva/trunk/archiva-docs/src/site/apt/userguide/find-artifact.apt
URL:
http://svn.apache.org/viewvc/archiva/trunk/archiva-docs/src/site/apt/userguide/find-artifact.apt?rev=754614&r1=754613&r2=754614&view=diff
==============================================================================
--- archiva/trunk/archiva-docs/src/site/apt/userguide/find-artifact.apt
(original)
+++ archiva/trunk/archiva-docs/src/site/apt/userguide/find-artifact.apt Sun Mar
15 04:54:09 2009
@@ -24,13 +24,26 @@
[../images/find-artifact.png] Find Artifact
- Once you submit the form Archiva will look to match the checksum:
+ To find an artifact, perform the following steps:
- * If more than one artifact matches, a list of results are returned
+ [[1]] Click <<Find Artifact>> in the left navigation menu.
- * If a unique match is found, the individual artifact information page is
returned
+ [[2]] On the opened page, you will see a file-upload field. Upload any JAR
file (or other artifact) from your local file system. You must enter an exact
filename. In general, you would use the Browse button for entering the filename.
- * If no match is found, a "no results" page is returned
+ [[3]] Click Search.
+ [[4]] The whole file is not uploaded, but the checksum is. It will search
the remote repository for an exact match of the file you specified and display
the result of the search.
+
+ []
+
+ Once you submit the form, Archiva will look to match the checksum:
+
+ * If more than one artifact matches, a list of results is returned.
+
+ * If a unique match is found, the individual artifact information page is
returned.
+
+ * If no match is found, a "no results" page is returned.
+
+ []
Added: archiva/trunk/archiva-docs/src/site/resources/images/upload-artifact.jpg
URL:
http://svn.apache.org/viewvc/archiva/trunk/archiva-docs/src/site/resources/images/upload-artifact.jpg?rev=754614&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
archiva/trunk/archiva-docs/src/site/resources/images/upload-artifact.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: archiva/trunk/archiva-docs/src/site/site.xml
URL:
http://svn.apache.org/viewvc/archiva/trunk/archiva-docs/src/site/site.xml?rev=754614&r1=754613&r2=754614&view=diff
==============================================================================
--- archiva/trunk/archiva-docs/src/site/site.xml (original)
+++ archiva/trunk/archiva-docs/src/site/site.xml Sun Mar 15 04:54:09 2009
@@ -34,6 +34,7 @@
<item name="Browsing" href="/userguide/browsing.html" />
<item name="Searching" href="/userguide/searching.html"
/>
<item name="Identifying an Artifact"
href="/userguide/find-artifact.html" />
+ <item name="Deleting an Artifact"
href="/userguide/delete-artifact.html" />
<item name="Using as a repository"
href="/userguide/using-repository.html" />
<item name="Deploying to repository" href="/userguide/deploy.html" />
<item name="Configuring Virtual Repositories"
href="/userguide/virtual-repositories.html" />
