Improved documentation a little bit.
o Changed description in pom.
o Added some parts as documentation.
git-svn-id: https://svn.apache.org/repos/asf/maven/shared/trunk@1794195 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/pom.xml b/pom.xml
index ebb82a1..fbc0dad 100644
--- a/pom.xml
+++ b/pom.xml
@@ -31,7 +31,7 @@
<version>0.9.1-SNAPSHOT</version>
<name>Apache Maven Artifact Transfer</name>
- <description>An API to install, deploy and resolving artifacts with Maven3</description>
+ <description>An API to install, deploy and resolving artifacts with Maven 3</description>
<scm>
<connection>scm:svn:http://svn.apache.org/repos/asf/maven/shared/trunk/maven-artifact-transfer</connection>
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
new file mode 100644
index 0000000..58b281a
--- /dev/null
+++ b/src/site/apt/index.apt.vm
@@ -0,0 +1,46 @@
+ -----
+ Introduction
+ -----
+ Karl Heinz Marbaise
+ -----
+ 2017-05-07
+ -----
+
+ ~~ 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/doxia/references/apt-format.html
+
+${project.name}
+
+ The Maven Artifact Transfer Component is intended as an API
+ to install, deploy and resolving artifacts in Maven 3.
+
+ The {{{./comparison.html} comparison will show }} the differences between
+ a dependency, artifact and a maven project.
+
+ The {{{./install-project.html} install project}} part will show
+ how to this component to make an install of an existing project
+ which makes the handling within plugins much easier.
+
+ <<Current State Of The Component>>
+ Currently this shared component has not yet reached the final 1.0.0 version state which means the interfaces can
+ change.
+
+
+
diff --git a/src/site/apt/install-project.apt b/src/site/apt/install-project.apt
new file mode 100644
index 0000000..eb07a08
--- /dev/null
+++ b/src/site/apt/install-project.apt
@@ -0,0 +1,57 @@
+ -----
+ Install Project
+ -----
+ Karl Heinz Marbaise
+ -----
+ 2017-05-07
+ -----
+
+ ~~ 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/doxia/references/apt-format.html
+
+Install a Project
+
+ If you are developing a maven plugin you need often to install artifacts
+ into the local repository which is a little bit cumbersome. This can be easily
+ done via the following code parts.
+
++---
+ @Parameter ( defaultValue = "${session}", required = true, readonly = true)
+ private MavenSession session;
+ @Parameter ( defaultValue = "${project}", required = true, readonly = true)
+ private MavenProject project;
+
+ @Component
+ private ProjectInstaller installer;
+ ...
+ public void execute() {
+
+ ProjectInstallerRequest pir =
+ new ProjectInstallerRequest()
+ .setProject( project ).setUpdateReleaseInfo( updateReleaseInfo );
+
+ installer.install( session.getProjectBuildingRequest(), pir );
+ ...
+ }
+
++---
+
+
+
\ No newline at end of file
diff --git a/src/site/site.xml b/src/site/site.xml
index bce4f6d..f46f50e 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -33,6 +33,7 @@
</menu>
<menu name="References">
<item name="Dependency vs Artifact vs MavenProject" href="comparison.html"/>
+ <item name="Install a Project" href="install-project.html"/>
</menu>
<menu ref="parent"/>
