]> source.dussan.org Git - archiva.git/commitdiff
interpolation for version display in doc
authorOlivier Lamy <olamy@apache.org>
Fri, 16 Sep 2011 13:58:20 +0000 (13:58 +0000)
committerOlivier Lamy <olamy@apache.org>
Fri, 16 Sep 2011 13:58:20 +0000 (13:58 +0000)
git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@1171567 13f79535-47bb-0310-9956-ffa450edef68

archiva-docs/src/site/apt/customising/writing-consumer.apt [deleted file]
archiva-docs/src/site/apt/customising/writing-consumer.apt.vm [new file with mode: 0644]

diff --git a/archiva-docs/src/site/apt/customising/writing-consumer.apt b/archiva-docs/src/site/apt/customising/writing-consumer.apt
deleted file mode 100644 (file)
index bae266b..0000000
+++ /dev/null
@@ -1,68 +0,0 @@
- ------
- Writing a Consumer Plugin
- ------
- Maria Odea Ching
- Olivier Lamy
- ------
- 06 Sep 2011
- ------
-
-~~ 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
-
-Writing a Consumer Plugin
-
- For a sample custom consumer, you can checkout the archiva-consumer-plugin at the archiva sandbox in the SVN repository:
- Prior to release 1.4, plexus components are not anymore supported, you must use Spring components.
-
-+----+
-http://svn.apache.org/repos/asf/archiva/sandbox/archiva-consumer-plugin
-+----+
-
- Below are the steps on how to create a custom repository consumer and plug it in Archiva:
-
- [[1]] Create a project for your component.
-
- [[2]] Declare your class or in this case, consumer as a component as shown in the example below. This
-   should be put at the class level.
-
-+----+
-Ex.
-@Service("knownRepositoryContentConsumer#discover-new-artifact")
-@Scope("prototype")
-
-where,
-  Service: unique id for your consumer.
-  Scope: the creation strategy prototype or singleton.
-+----+
-
- [[4]] Package your project by executing 'mvn clean package'
-
- [[5]] Let's say you are using the apache-archiva-1.0-bin.tar.gz to run Archiva. Unpack
-   the binaries then go to bin/linux-x86-32/ (assuming you are running on Linux), then execute
-   './run.sh console'. Then stop or shutdown Archiva after it started. (This is necessary to unpack
-   the war file.)
-
- [[6]] Copy the jar file you created in step 4 in apache-archiva-1.0/apps/archiva/webapp/lib/
-
- [[7]] Add the necessary configurations in archiva.xml (in this case, add 'discover-new-artifact' as a
-   <knownContentConsumer>)
-
- [[8]] Start up Archiva again.
diff --git a/archiva-docs/src/site/apt/customising/writing-consumer.apt.vm b/archiva-docs/src/site/apt/customising/writing-consumer.apt.vm
new file mode 100644 (file)
index 0000000..cc1c741
--- /dev/null
@@ -0,0 +1,68 @@
+ ------
+ Writing a Consumer Plugin
+ ------
+ Maria Odea Ching
+ Olivier Lamy
+ ------
+ 06 Sep 2011
+ ------
+
+~~ 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
+
+Writing a Consumer Plugin
+
+ For a sample custom consumer, you can checkout the archiva-consumer-plugin at the archiva sandbox in the SVN repository:
+ Prior to release 1.4, plexus components are not anymore supported, you must use Spring components.
+
++----+
+http://svn.apache.org/repos/asf/archiva/sandbox/archiva-consumer-plugin
++----+
+
+ Below are the steps on how to create a custom repository consumer and plug it in Archiva:
+
+ [[1]] Create a project for your component.
+
+ [[2]] Declare your class or in this case, consumer as a component as shown in the example below. This
+   should be put at the class level.
+
++----+
+Ex.
+@Service("knownRepositoryContentConsumer#discover-new-artifact")
+@Scope("prototype")
+
+where,
+  Service: unique id for your consumer.
+  Scope: the creation strategy prototype or singleton.
++----+
+
+ [[4]] Package your project by executing 'mvn clean package'
+
+ [[5]] Let's say you are using the apache-archiva-${project.version}-bin.tar.gz to run Archiva. Unpack
+   the binaries then go to bin/linux-x86-32/ (assuming you are running on Linux), then execute
+   './run.sh console'. Then stop or shutdown Archiva after it started. (This is necessary to unpack
+   the war file.)
+
+ [[6]] Copy the jar file you created in step 4 in apache-archiva-${project.version}/apps/archiva/webapp/lib/
+
+ [[7]] Add the necessary configurations in archiva.xml (in this case, add 'discover-new-artifact' as a
+   <knownContentConsumer>)
+
+ [[8]] Start up Archiva again.