You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2017/12/08 18:15:50 UTC
[maven-shared-resources] 03/26: Add a site.
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-shared-resources.git
commit d8320707739a878b3293c3c2ac99ee9d79245866
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Sun May 1 11:08:33 2011 +0000
Add a site.
git-svn-id: https://svn.apache.org/repos/asf/maven/shared/trunk@1098256 13f79535-47bb-0310-9956-ffa450edef68
---
src/site/apt/index.apt.vm | 49 +++++++++++++++++++++
src/site/apt/usage.apt.vm | 109 ++++++++++++++++++++++++++++++++++++++++++++++
src/site/site.xml | 29 ++++++++++++
3 files changed, 187 insertions(+)
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
new file mode 100644
index 0000000..073223d
--- /dev/null
+++ b/src/site/apt/index.apt.vm
@@ -0,0 +1,49 @@
+ ------
+ Introduction
+ ------
+ Dennis Lundberg
+ ------
+ 2011-05-01
+ ------
+
+~~ 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.
+
+Maven Shared Resources
+
+ This is a collection of templates that are specific to the Maven project. They
+ are probably not of interest to projects other than Apache Maven.
+
+ Below you will find a listing of the resources that can be found in the
+ current version (${project.version}) of Maven Shared Resources. They are
+ listed by which plugin they are meant to be used with.
+
+
+* Maven Changes Plugin
+
+** org/apache/maven/plugins/announcement.vm
+
+ This is a template that can be used by Maven Changes Plugin to create and send
+ an announcement e-mail for one of our plugins. It will create an announcement
+ e-mail that conforms to the "Promote the release" section of our
+ {{{http://maven.apache.org/developers/release/maven-project-release-procedure.html#Promote_the_release}release procedure}}.
+
+
+* Usage
+
+ General instructions on how to use the Maven Shared Resources can be found on
+ the {{{./usage.html}usage page}}.
diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm
new file mode 100644
index 0000000..9e29e9f
--- /dev/null
+++ b/src/site/apt/usage.apt.vm
@@ -0,0 +1,109 @@
+ ------
+ Usage
+ ------
+ Dennis Lundberg
+ ------
+ 2011-05-01
+ ------
+
+~~ 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.
+
+Usage
+
+ There are a couple things you need to do to use Maven Shared Resources. First
+ you need to give the plugin that will use the resources access to them. After
+ that you configure the plugin to actually use the resources.
+
+
+* Add the resources to the plugin
+
+ First you add maven-shared-resources as a dependency to a plugin in your
+ <<<pom.xml>>>. This is done to give the plugin access to the resources within
+ the maven-shared-resources JAR file. In this example we will use the resources
+ in Maven Changes Plugin.
+
++----------+
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changes-plugin</artifactId>
+ <version>2.4</version>
+ <configuration>
+ ...
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ </dependencies>
+ <executions>
+ ...
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project>
++----------+
+
+
+* Configure the plugin to use the resources
+
+ Now you can use the resources in the plugin. You can use them as if they
+ existed in your own project, like this:
+
++----------+
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changes-plugin</artifactId>
+ <version>2.4</version>
+ <configuration>
+ <templateDirectory>org/apache/maven/plugins</templateDirectory>
+ </configuration>
+ <dependencies>
+ ...
+ </dependencies>
+ <executions>
+ ...
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project>
++----------+
+
+
+* Execute the plugin
+
+ All is now set up to make use of the resources in the plugin for your project.
+ Execute the plugin like you would normally do, to see the resources put to
+ practical use.
+
++----------+
+mvn changes:announcement-generate
++----------+
diff --git a/src/site/site.xml b/src/site/site.xml
new file mode 100644
index 0000000..f58e01d
--- /dev/null
+++ b/src/site/site.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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.
+-->
+
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
+ <body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="Usage" href="usage.html"/>
+ </menu>
+ </body>
+</project>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.