onami-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From randg...@apache.org
Subject svn commit: r1456626 - in /incubator/onami/trunk/lifecycle/warmup/src/site: apt/index.apt.vm apt/warmup.apt site.xml
Date Thu, 14 Mar 2013 19:51:17 GMT
Author: randgalt
Date: Thu Mar 14 19:51:16 2013
New Revision: 1456626

URL: http://svn.apache.org/r1456626
Log:
Conform to other project's help sites

Added:
    incubator/onami/trunk/lifecycle/warmup/src/site/apt/warmup.apt
      - copied, changed from r1456593, incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm
Modified:
    incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm
    incubator/onami/trunk/lifecycle/warmup/src/site/site.xml

Modified: incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm?rev=1456626&r1=1456625&r2=1456626&view=diff
==============================================================================
--- incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm (original)
+++ incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm Thu Mar 14 19:51:16 2013
@@ -53,36 +53,3 @@ Before starting
   ...
 </dependencies>
 +--------------------------------------+
-
-Usage
-
- To use, install the WarmUpModule in your Guice injector. To initiate the warm up, get the
warm up stager and
- call the stage() method.
-
-+--------------------------------------+
-Injector injector = Guice.createInjector( WarmUpModule().newWarmUpModule() );
-// ...
-Stager<WarmUp> warmUpStager = injector.get( LifeCycleStageModule.key(WarmUp.class)
);
-warmUpStager.stage(); // causes all injected object's @WarmUp methods to get called
-+--------------------------------------+
-
- Of course, instead of getting the stager from the injector you can declare it as a dependency:
-
-+--------------------------------------+
-public class MyClass
-{
-    private final Stager<WarmUp> stager;
-
-    @Inject
-    public MyClass(Stager<WarmUp> stager)
-    {
-        this.stager = stager;
-    }
-
-    @AfterInjection
-    public void start()
-    {
-        stager.stage();
-    }
-}
-+--------------------------------------+

Copied: incubator/onami/trunk/lifecycle/warmup/src/site/apt/warmup.apt (from r1456593, incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm)
URL: http://svn.apache.org/viewvc/incubator/onami/trunk/lifecycle/warmup/src/site/apt/warmup.apt?p2=incubator/onami/trunk/lifecycle/warmup/src/site/apt/warmup.apt&p1=incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm&r1=1456593&r2=1456626&rev=1456626&view=diff
==============================================================================
--- incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm (original)
+++ incubator/onami/trunk/lifecycle/warmup/src/site/apt/warmup.apt Thu Mar 14 19:51:16 2013
@@ -24,37 +24,7 @@
 ~~ under the License.
 ~~
 
-Welcome to Apache Onami-Lifecycle Warm Up!
-
- Methods annotated with @WarmUp will be called in parallel
- (using the Java Fork-Join framework). Object
- dependencies are respected – i.e. given:
-
-[./images/abc.png]
-
- * Object A is dependent on objects B and C and all have warm up methods.
-
- * Object A’s warm up method will not be executed until both objects B and C’s
warm up methods complete.
-
- * Objects B and C’s warm up methods will execute in parallel.
-
-Before starting
-
-  Lifecycle Warm Up is available on the Maven Central repo, you just need to add the dependency
below in your <<<pom.xml>>> file:
-
-+--------------------------------------+
-<dependencies>
-  ...
-  <dependency>
-    <groupId>${project.groupId}</groupId>
-    <artifactId>${project.artifactId}</artifactId>
-    <version>${project.version}</version>
-  </dependency>
-  ...
-</dependencies>
-+--------------------------------------+
-
-Usage
+User's Guide
 
  To use, install the WarmUpModule in your Guice injector. To initiate the warm up, get the
warm up stager and
  call the stage() method.

Modified: incubator/onami/trunk/lifecycle/warmup/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/onami/trunk/lifecycle/warmup/src/site/site.xml?rev=1456626&r1=1456625&r2=1456626&view=diff
==============================================================================
--- incubator/onami/trunk/lifecycle/warmup/src/site/site.xml (original)
+++ incubator/onami/trunk/lifecycle/warmup/src/site/site.xml Thu Mar 14 19:51:16 2013
@@ -28,6 +28,7 @@
 
     <menu name="Apache Onami™ Lifecycle Warm Up">
       <item name="Home" href="index.html" />
+      <item name="User Guide" href="warmup.html" />
     </menu>
 
     <menu ref="reports"/>



Mime
View raw message