Author: nlebas
Date: Mon Mar 26 19:27:30 2012
New Revision: 1305507
URL: http://svn.apache.org/viewvc?rev=1305507&view=rev
Log:
site documentation for tiles-request
Added:
tiles/framework/trunk/tiles-request/src/site/apt/
tiles/framework/trunk/tiles-request/src/site/apt/dev/
tiles/framework/trunk/tiles-request/src/site/apt/dev/release.apt
tiles/framework/trunk/tiles-request/src/site/xdoc/dev/
tiles/framework/trunk/tiles-request/src/site/xdoc/dev/building.xml
tiles/framework/trunk/tiles-request/src/site/xdoc/dev/snapshots.xml
tiles/framework/trunk/tiles-request/tiles-request-mustache/src/site/
tiles/framework/trunk/tiles-request/tiles-request-mustache/src/site/site.xml
- copied, changed from r1305506,
tiles/framework/trunk/tiles-request/src/site/site.xml
Modified:
tiles/framework/trunk/tiles-autotag/pom.xml
tiles/framework/trunk/tiles-request/pom.xml
tiles/framework/trunk/tiles-request/src/site/site.xml
tiles/framework/trunk/tiles-request/src/site/xdoc/index.xml
Modified: tiles/framework/trunk/tiles-autotag/pom.xml
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/pom.xml?rev=1305507&r1=1305506&r2=1305507&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-autotag/pom.xml (original)
+++ tiles/framework/trunk/tiles-autotag/pom.xml Mon Mar 26 19:27:30 2012
@@ -80,7 +80,6 @@ under the License.
<excludedLink>**/index.html</excludedLink>
<excludedLink>**/logo.png</excludedLink>
</excludedLinks>
- <forceSite>false</forceSite>
</configuration>
</plugin>
</plugins>
Modified: tiles/framework/trunk/tiles-request/pom.xml
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-request/pom.xml?rev=1305507&r1=1305506&r2=1305507&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-request/pom.xml (original)
+++ tiles/framework/trunk/tiles-request/pom.xml Mon Mar 26 19:27:30 2012
@@ -80,7 +80,6 @@ under the License.
<excludedLink>**/index.html</excludedLink>
<excludedLink>**/logo.png</excludedLink>
</excludedLinks>
- <forceSite>false</forceSite>
</configuration>
</plugin>
</plugins>
Added: tiles/framework/trunk/tiles-request/src/site/apt/dev/release.apt
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-request/src/site/apt/dev/release.apt?rev=1305507&view=auto
==============================================================================
--- tiles/framework/trunk/tiles-request/src/site/apt/dev/release.apt (added)
+++ tiles/framework/trunk/tiles-request/src/site/apt/dev/release.apt Mon Mar 26
19:27:30 2012
@@ -0,0 +1,351 @@
+~~ $Id$
+~~
+~~ 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.
+~~
+ -----------
+ Release Process
+ -----------
+
+Tiles Release Process
+
+ Here you will find the steps to create releases for Tiles.
+
+Prerequisites
+
+ To create a release you have to install:
+
+ * {{{http://java.sun.com/javase/6}Java 6.0}}. If you are using a newer
+ version of Java, it is suggested to <<change JAVA_HOME environment variable>>
+ when calling Maven, so it points to an instance of Java 6.0;
+
+ * {{{http://maven.apache.org/}Maven 2.2 or 3}};
+
+ * {{{http://www.gnupg.org/}GnuPG}};
+
+ * {{{http://www.openssh.com/}OpenSSH}};
+
+ * {{{http://www.graphviz.org/}GraphViz}};
+
+One-time operations
+
+ These operations need to be performed only one time.
+
+* Create and publish your GPG key
+
+ To create a GPG key, follow the
+ {{{http://www.apache.org/dev/openpgp.html}guidelines}}.
+ Include it in:
+
+-------------------------------------
+https://svn.apache.org/repos/asf/tiles/site/KEYS
+-------------------------------------
+
+ Publish your GPG key in a PGP key server, such as
+ {{{http://pgp.mit.edu/} MIT Keyserver}}.
+
+* Create and upload yout SSH key
+
+ * Generate your SSH key (in this case we will use DSA encryption):
+
+---------------------------------
+ssh-keygen -t rsa
+---------------------------------
+
+ * Copy your public key to the server:
+
+--------------------------------------
+scp ~/.ssh/id_rsa.pub [email protected]:.ssh/authorized_keys
+--------------------------------------
+
+ * Try to login:
+
+---------------------------------
+ssh [email protected]
+---------------------------------
+
+ If it does not ask you a password, everything is ok.
+
+* Modify <<<settings.xml>>>
+
+ Your <<<settings.xml>>> must be modified to allow deployment.
+
+ This is the minimal configuration, obviously if you already have a
<<<settings.xml>>> file,
+ you must edit it:
+
+---------------------------
+<settings xmlns="http://maven.apache.org/POM/4.0.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+ http://maven.apache.org/xsd/settings-1.0.0.xsd";>
+ <servers>
+ <server>
+ <id>apache-site</id>
+ <username>YOUR_APACHE_USERNAME</username>
+ <filePermissions>664</filePermissions>
+ <directoryPermissions>775</directoryPermissions>
+ </server>
+ <server>
+ <id>apache.snapshots.https</id>
+ <username>YOUR_APACHE_USERNAME</username>
+ <password>YOUR_APACHE_PASSWORD</password>
+ </server>
+ <server>
+ <id>apache.releases.https</id>
+ <username>YOUR_APACHE_USERNAME</username>
+ <password>YOUR_APACHE_PASSWORD</password>
+ </server>
+ </servers>
+ <profiles>
+ <profile>
+ <id>release</id>
+ <properties>
+ <gpg.passphrase>YOUR_SECRET_PHRASE</gpg.passphrase>
+ </properties>
+ </profile>
+ </profile>
+ </profiles>
+</settings>
+---------------------------
+
+Repeatable operations
+
+ These steps must be performed <<for each>> release.
+
+* Prepare the release tag
+
+ To prepare the release Subversion tag, check out the branch/trunk from where
+ you are preparing the release and type:
+
+-----------------------------------
+mvn release:prepare -Dusername=YOUR_SVN_USER -Dpassword=YOUR_SVN_PASSWORD
+-----------------------------------
+
+ The plugin interactively will ask you the version to release, the Subversion
+ tag to use and the next snapshot version. It is reccomended to use the tag:
+ <<tiles-X.X.X>>.
+
+* Perform the Release
+
+ To perform the release, i.e. creating and deploying Maven artifacts, use:
+
+-----------------------------------
+mvn release:perform
+-----------------------------------
+
+* Close the staging repository
+
+ Login to {{{https://repository.apache.org using} Nexus repository}} your
Apache LDAP credentials.
+ Click on "Staging". Then click on "tiles" in the list of repositories.
+ In the panel below you should see an open repository that is linked to your
username and ip.
+ Right click on this repository and select "Close".
+ This will close the repository from future deployments and make it available
for others to view.
+ If you are staging multiple releases together, skip this step until you have
staged everything.
+ Enter the name and version of the artifact being released in the
"Description" field and then click "Close".
+ This will make it easier to identify it later.
+
+* Verify the staged artifacts
+
+ If you click on your repository, a tree view will appear below.
+ You can then browse the contents to ensure the artifacts are as you expect
them.
+ Pay particular attention to the existence of *.asc (signature) files.
+ If the you don't like the content of the repository, right click your
repository and choose "Drop".
+ You can then rollback your release and repeat the process.
+
+ Note the repository URL, you will need this in your vote email.
+
+* Digest and upload assemblies
+
+ * Go into the release assembly target directory:
+
+-----------------------------------
+cd target/checkout/assembly/target/assembly/out
+-----------------------------------
+
+ * Create MD5 and SHA1 files for each files (including ASC files). You can do
+ it with this simple shell script:
+
+-----------------------------------
+#!/bin/sh
+
+for fileitem in *
+do
+ openssl md5 < $fileitem > $fileitem.md5
+ openssl sha1 < $fileitem > $fileitem.sha1
+done
+-----------------------------------
+
+ * Upload everything to the build site:
+
+-----------------------------------
+scp * [email protected]:/www/people.apache.org/builds/tiles/${version}
+-----------------------------------
+
+* Release the JIRA version
+
+ * In JIRA go to the version that you want to release and release it.
+
+ * Create a new version, if it has not been done before.
+
+ * Create the release notes and <<write down the link>> that it uses.
+
+* Send announcement for the test build
+
+ In <<developers mailing list>> send an announcement for the test build:
+
+-----------------------------------
+Subject: [ANNOUNCE] Tiles ${version} test build available
+
+The test build of Tiles ${version} is available.
+
+
+No determination as to the quality ('alpha,' 'beta,' or 'GA') of Tiles
+${version} has been made, and at this time it is simply a "test build". We
+welcome any comments you may have, and will take all feedback into
+account if a quality vote is called for this build.
+
+Release notes:
+
+* ${jira.release.notes}
+
+Distribution:
+
+ * http://people.apache.org/builds/tiles/${version}/
+
+Maven 2 staging repository:
+
+ * https://repository.apache.org/content/repositories/tiles-[YOUR REPOSITORY
ID]/
+
+A vote regarding the quality of this test build will be initiated
+within the next couple of days.
+-----------------------------------
+
+* Call for a vote
+
+ A few days after the test build announcement, call for a vote in
+ <<developers mailing list>>.
+
+-----------------------------------
+Subject: [VOTE] ${version} Release Quality
+
+The Tiles ${version} test build has been available since ${testBuildDate}.
+
+Release notes:
+
+* ${jira.release.notes}
+
+Distribution:
+
+ * http://people.apache.org/builds/tiles/${version}/
+
+Maven 2 staging repository:
+
+ * https://repository.apache.org/content/repositories/tiles-[YOUR REPOSITORY
ID]/
+
+If you have had a chance to review the test build, please respond with
+a vote on its quality:
+
+ [ ] Leave at test build
+ [ ] Alpha
+ [ ] Beta
+ [ ] General Availability (GA)
+
+
+Everyone who has tested the build is invited to vote. Votes by PMC
+members are considered binding. A vote passes if there are at least
+three binding +1s and more +1s than -1s.
+-----------------------------------
+
+* Post-vote operations
+
+ After a vote is finished, and it has been decided that is
+ <<at least of alpha quality>>, there is the need of a post-vote process.
+
+** Promote staged artifacts
+
+ Once the release is deemed fit for public consumption it can be transfered
to a production repository where it will be available to all users.
+
+ Login to {{{https://repository.apache.org}Nexus repository}} again.
+ Click on "Staging" and then on the repository with id "tiles-staging".
+ Find your closed staging repository, right click on it and choose "Promote".
+ Select the "Releases" repository and click "Promote".
+
+ Next click on "Repositories", select the "Releases" repository
+ and validate that your artifacts exist as you expect them.
+
+** Move assemblies
+
+ * Move assemblies to the Apache distribution mirrors:
+
+-------------------------------------------
+ssh [email protected]
+
+cd /www/people.apache.org/builds/tiles/${version}
+mkdir /www/www.apache.org/dist/tiles/v${version}/
+cp * /www/www.apache.org/dist/tiles/v${version}/
+-------------------------------------------
+
+** Update the site
+
+ * Wait 24 hours to let the mirror sync to the release and then update the
+ site. In particular you have to update the index and the download pages:
+
+------------------------------------------------
+https://svn.apache.org/repos/asf/tiles/site/src/site/xdoc/index.xml
+https://svn.apache.org/repos/asf/tiles/site/src/site/apt/download.apt
+------------------------------------------------
+
+ Build and publish the site:
+
+--------------------------------------
+mvn site
+mvn site:deploy
+--------------------------------------
+
+** Send announcement
+
+ Finally, send an an announcement to the <<users>> and <<developers mailing
+ list>>:
+
+--------------------------------------
+Subject: [ANNOUNCE] Tiles ${version} ${quality} released
+
+The Apache Tiles team is pleased to announce the release of Tiles ${version}
+${quality}.
+
+Tiles ${version} is available in a binary and a source distribution.
+
+http://tiles.apache.org/download.html
+
+It is also available in the central Maven repository under Group ID
+"org.apache.tiles".
+
+The 2.0.x series of the Apache Tiles framework has a minimum
+requirement of the following specification versions:
+
+* Java Servlet 2.4 and JavaServer Pages (JSP) 2.0
+* Java Standard Edition (Java SE) 1.5
+
+The release notes are available online at:
+
+* ${jira.release.notes}
+
+Please feel free to test the distribution and post your comments to
+the user list, or, if appropriate, file a ticket with JIRA.
+--------------------------------------
+
+ <<You have finished!>>
Modified: tiles/framework/trunk/tiles-request/src/site/site.xml
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-request/src/site/site.xml?rev=1305507&r1=1305506&r2=1305507&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-request/src/site/site.xml (original)
+++ tiles/framework/trunk/tiles-request/src/site/site.xml Mon Mar 26 19:27:30
2012
@@ -45,7 +45,7 @@
name="Tiles Home"
href="../index.html"/>
<item
- name="Request Microframework"
+ name="Tiles Request Microframework"
href="./index.html"/>
</menu>
<menu name="Reference">
@@ -64,9 +64,6 @@
<item
name="Release Process"
href="/dev/release.html"/>
- <item
- name="Selenium Testing"
- href="/selenium.html"/>
</menu>
<menu ref="modules" />
Added: tiles/framework/trunk/tiles-request/src/site/xdoc/dev/building.xml
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-request/src/site/xdoc/dev/building.xml?rev=1305507&view=auto
==============================================================================
--- tiles/framework/trunk/tiles-request/src/site/xdoc/dev/building.xml (added)
+++ tiles/framework/trunk/tiles-request/src/site/xdoc/dev/building.xml Mon Mar
26 19:27:30 2012
@@ -0,0 +1,90 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * $Id$
+ *
+ * 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.
+ */
+-->
+<document>
+
+ <properties>
+ <title>Apache Request Microframework</title>
+ </properties>
+
+ <body>
+ <section name="Building the Request Microframework">
+ <subsection name="Prerequisites">
+ <p>For all the next instructions, we assume that you downloaded and
+ installed <a href="http://maven.apache.org/";>Maven</a>.</p>
+ <p>To download packages from the source repository, you need to
+ download and install <a href="http://subversion.tigris.org/";>
+ Subversion</a>.</p>
+ <p>If you want to build something including JavaDocs (assemblies,
+ sites and JavaDoc report itself) you need to install
+ <a href="http://www.graphviz.org/";>GraphViz</a>, otherwise you will
+ notice missing pictures inside JavaDocs pages.</p>
+ </subsection>
+ <subsection name="Building main packages">
+ <p>To build the Request Microframework from source you need to:</p>
+ <ul>
+ <li><p><a href="../../download.html">download</a> the source
+ distribution, or checkout the latest version:</p>
+ <p><source>svn co
http://svn.apache.org/repos/asf/tiles/framework/trunk/tiles-request</source></p></li>
+ <li><p>go into the source directory and type:</p>
+ <p><source>mvn package</source></p></li>
+ </ul>
+ <p>You will find the generated JARs under:</p>
+ <ul>
+
<li>{tiles-dir}/tiles-request-api/target/tiles-request-api-${version}.jar</li>
+
<li>{tiles-dir}/tiles-request-{implementation}/target/tiles-request-{implementation}-${version}.jar</li>
+ </ul>
+ </subsection>
+ </section>
+ <section name="Building the websites">
+ <p>There are four Tiles websites: the main website and the projects
+ websites (tiles-request, tiles-autotag and framework).</p>
+ <subsection name="Building the main website">
+ <p>To build the main website:</p>
+ <ul>
+ <li><p>checkout the site from the source repository:</p>
+ <p><source>svn co
http://svn.apache.org/repos/asf/tiles/site/</source></p></li>
+ <li><p>go into the site directory and type:</p>
+ <p><source>mvn site</source></p></li>
+ </ul>
+ <p>You will find the generated distribution under
+ <code>{tiles-site-dir}/target/site</code>.</p>
+ </subsection>
+ <subsection name="Building the tiles-request website">
+ <p>To build a project's website:</p>
+ <ul>
+ <li><p><a href="../download.html">download</a> the source
+ distribution, or checkout the latest version:</p>
+ <p><source>svn co
http://svn.apache.org/repos/asf/tiles/framework/trunk/tiles-request</source></p></li>
+ <li><p>go into the source directory and type:</p>
+ <p><source>mvn site site:stage</source></p></li>
+ </ul>
+ <p>You will find the generated website under:</p>
+ <ul>
+ <li>{tiles-request-dir}/target/staging</li>
+ </ul>
+ </subsection>
+ </section>
+ </body>
+
+</document>
Added: tiles/framework/trunk/tiles-request/src/site/xdoc/dev/snapshots.xml
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-request/src/site/xdoc/dev/snapshots.xml?rev=1305507&view=auto
==============================================================================
--- tiles/framework/trunk/tiles-request/src/site/xdoc/dev/snapshots.xml (added)
+++ tiles/framework/trunk/tiles-request/src/site/xdoc/dev/snapshots.xml Mon Mar
26 19:27:30 2012
@@ -0,0 +1,64 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * $Id$
+ *
+ * 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.
+ */
+-->
+<document>
+
+ <properties>
+ <title>Apache Tiles</title>
+ </properties>
+
+ <body>
+ <section name="Apache Tiles™">
+ <subsection name="Snapshots">
+
+ <p>Looking for snapshot builds of the latest version of Tiles?
+ Snapshots are occasionally published to Apache's Maven snapshot
+ repository, which can be accessed with the following
configuration:</p>
+
+ <source>
+ <![CDATA[
+ <repository>
+ <id>apache.snapshots</id>
+ <name>Apache Maven Snapshot Repository</name>
+ <url>http://repository.apache.org/snapshots</url>
+ </repository>
+ ]]>
+ </source>
+
+ <p>After configuring the repository, declare a dependency on
+ Tiles Request:</p>
+
+ <source><![CDATA[
+ <dependency>
+ <groupId>org.apache.tiles</groupId>
+ <artifactId>tiles-request-api</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ </dependency>
+ ]]>
+ </source>
+
+ </subsection>
+</section>
+</body>
+
+</document>
Modified: tiles/framework/trunk/tiles-request/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-request/src/site/xdoc/index.xml?rev=1305507&r1=1305506&r2=1305507&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-request/src/site/xdoc/index.xml (original)
+++ tiles/framework/trunk/tiles-request/src/site/xdoc/index.xml Mon Mar 26
19:27:30 2012
@@ -31,8 +31,9 @@
<section name="Apache Request microframework project">
+ <p>Tiles has served the purpose of rendering views for the
Model-View-Controller pattern in JavaEE for years.</p>
<p>Tiles-3 introduces a complete standalone and super simple
abstraction around request/response objects.
- <p>We've all seen that the various technologies like Servlet,
Portlet, JSP, Velocity, FreeMarker seem to have a different abstraction of a
common pattern.
+ <p>We've all seen that the various technologies like Servlet,
Portlet, JSP, Velocity, FreeMarker seem to have a different abstraction of a
common pattern.
They all have a concept of:</p>
<ul>
<li>request: the client request, or some sort of it;</li>
@@ -41,9 +42,9 @@
<li>scope: places where different attribute maps are stored
(request, session, etc.)</li>
</ul>
<p>Now all of these scopes are concentrated into "Request"
interfaces, that acts as a single point of reference for the developer.
- In theory, everything can be obtained by an object that implements
Request.</p>
+ In theory, everything you need for rendering a view can be
obtained by an object that implements Request, and Request implementations can
be built that do not rely on an application server environment.</p>
<p> </p>
- <p>Currently there are bindings for Servlet, Portlet, JSP,
Velocity and FreeMarker.</p></p>
+ <p>Currently there are bindings for Servlet, Portlet, JSP,
Mustache, Velocity and FreeMarker.</p></p>
</section>
</body>
Copied:
tiles/framework/trunk/tiles-request/tiles-request-mustache/src/site/site.xml
(from r1305506, tiles/framework/trunk/tiles-request/src/site/site.xml)
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-request/tiles-request-mustache/src/site/site.xml?p2=tiles/framework/trunk/tiles-request/tiles-request-mustache/src/site/site.xml&p1=tiles/framework/trunk/tiles-request/src/site/site.xml&r1=1305506&r2=1305507&rev=1305507&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-request/src/site/site.xml (original)
+++
tiles/framework/trunk/tiles-request/tiles-request-mustache/src/site/site.xml
Mon Mar 26 19:27:30 2012
@@ -43,30 +43,10 @@
<menu name="Apache Tiles™">
<item
name="Tiles Home"
- href="../index.html"/>
+ href="../../index.html"/>
<item
name="Request Microframework"
- href="./index.html"/>
- </menu>
- <menu name="Reference">
- <item
- name="Javadoc"
- href="apidocs/index.html"/>
- </menu>
-
- <menu name="Developers">
- <item
- name="Building"
- href="/dev/building.html"/>
- <item
- name="Snapshots"
- href="/dev/snapshots.html"/>
- <item
- name="Release Process"
- href="/dev/release.html"/>
- <item
- name="Selenium Testing"
- href="/selenium.html"/>
+ href="../index.html"/>
</menu>
<menu ref="modules" />
