This is an automated email from the ASF dual-hosted git repository. gk pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/turbine-fulcrum-site.git
commit fb50b70229560a49d9bd1fbfe3cd96d59f07b3e6 Author: Georg Kallidis <[email protected]> AuthorDate: Thu May 11 13:12:14 2017 +0000 - site update build and download, version fix git-svn-id: https://svn.apache.org/repos/asf/turbine/fulcrum/trunk/site@1794834 13f79535-47bb-0310-9956-ffa450edef68 --- src/site/site.xml | 2 +- xdocs/building.xml | 47 ++++++++++++++++++++++++++++++++--------------- xdocs/index.xml | 6 +++--- 3 files changed, 36 insertions(+), 19 deletions(-) diff --git a/src/site/site.xml b/src/site/site.xml index 041896d..13f806f 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -39,7 +39,7 @@ <menu name="Fulcrum"> <item name="Overview" href="/"/> - <item name="Building" href="/building.html"/> + <item name="Download and Build" href="/building.html"/> </menu> <menu name="Released Components"> diff --git a/xdocs/building.xml b/xdocs/building.xml index 979ddd9..e21bb31 100644 --- a/xdocs/building.xml +++ b/xdocs/building.xml @@ -21,7 +21,7 @@ <document> <properties> - <title>Building Fulcrum</title> + <title>Download and Building Fulcrum</title> <!-- author email="[email protected]">Pete Kazmier</author> <author email="[email protected]">Quinton McCombs</author> <author email="[email protected]">Eric Pugh</author --> @@ -29,30 +29,47 @@ <body> - <section name="Building Fulcrum"> + <section name="Binary And Source Distributions"> + <p> + If you already know how to use Fulcrum and simply want the latest + binaries or source, you can get them from the + <a target="_blank" href="http://www.apache.org/dyn/closer.cgi/turbine/fulcrum";>Apache Mirror System</a>. + </p> + </section> + + <section name="Building all Fulcrum components"> <p> Building Fulcrum from SVN is now very easy because it has been Maven-enabled. Before you begin, you'll need to check out the <code>turbine-fulcrum</code> SVN repository (if you are not familiar with the Apache SVN repositories, please refer to the <a href="http://apache.org/dev/version-control.html";>documentation</a>). + <source> + svn checkout http://svn.apache.org/repos/asf/turbine/fulcrum/trunk/ + </source> </p> - <h4>Maven 2 Build</h4> + <h4>Maven 3 Build</h4> <p> - Please refer to the Maven 2/3 <a + Please refer to the Maven 3 <a href="http://maven.apache.org/guides/getting-started/";>Getting Started</a> document for instructions on how to install and use Maven. </p> <p> From the root directory of the Fulcrum project (where you checked - out the code to or unpacked a source distribution), simply type 'mvn install' - and press enter. This will start a process that will + out the code to or unpacked a source distribution), simply run + <source> + mvn install + </source> + This will start a process that will build each component. After the component is built, it will be installed into you local maven repository. </p> <p> - To build a local copy of the documentation, use 'mvn site'. + To build a local copy of the documentation, use this: + <source> + mvn site + </source> This will build a local copy of the web site in the 'target/site' directory. Note, this uses a LOT of memory. If you can't build all of them, build them individually. </p> @@ -61,14 +78,14 @@ Depending on your version of Maven, you may have various problems with the reports being generated, or you may run out of memory when you do a complete build. One approach to take is to turn off running unit tests - and excluding various components: - </p> - <h4>Maven 2 Build</h4> - <p>You could use the <strong>-pl (--projects)</strong> maven command line option. Yet another approach would be to use custom profile. - </p> - <source><![CDATA[ -$ maven -pl parser,crypto site' -]]></source> + <source><![CDATA[ + $ mvn site -DskipTests=true + ]]></source> + and/or excluding various components: + </p> + <source><![CDATA[ + $ mvn -pl parser,crypto site + ]]></source> </subsection> </section> </body> diff --git a/xdocs/index.xml b/xdocs/index.xml index 100e414..70af253 100644 --- a/xdocs/index.xml +++ b/xdocs/index.xml @@ -30,10 +30,10 @@ <p> Fulcrum was originally created as part of the Turbine 3 effort. The idea was to be able to decouple the services from Turbine 2 allowing them to be - used on both projects. + used on both projects. Turbine 4 uses now (2017) more than 15 Fulcrum components. </p> <p> - Fulcrum is currently evolving into a component repository based on the Avalon framework. + Fulcrum has evolved into a component repository based on the Avalon framework. Each service is being converted into a stand alone component that can be released independently of the other components. This will allow the Turbine project to to release components as they change instead of having @@ -49,7 +49,7 @@ documented in the docs for each component. </p> <p> - Additionally, Fulcrum offers the Yaafi component. Yaafi (Yet Another Avalon Framework + Additionally, Fulcrum offers the <a href="https://turbine.apache.org/fulcrum/fulcrum-yaafi/";>Yaafi component</a>. Yaafi (Yet Another Avalon Framework Implementation) is a very simple container that is meant to be used with singleton components. It is perfect for unit testing your components. You can then run them in any other Avalon container like ECM, Phoenix, Excalibur, etc..
