Website Wrapper for Apache Turbine Fulcrum Components

Clone this repo:
  1. 1ec9585 Update site navigation, move svn only fulcrums to section dormant (TODO sites not available) by Georg Kallidis · 7 months ago master
  2. 3cfaea4 Update Turbine Parent 11 by Georg Kallidis · 7 months ago
  3. 3d49b4f Remove duplicate custom/skin setting (since Turbone Parent 10 by Georg Kallidis · 8 months ago
  4. 07282ff fix svn, update readme, changes, explain module is a project site build component by Georg Kallidis · 10 months ago
  5. 90e99aa adapt pom.xml for git scm by Georg Kallidis · 11 months ago

The Fulcrum Website Instructions


The Fulcrum web site is based on .xml files which are transformed into .html files using Maven.

http://maven.apache.org/

Description

The Fulcrum site builds the wrapper site for the Fulcrum components listed in site.xml.

It is a Website repository, which is used to provides a mechanism (Management Tool) to publish Turbine Fulcrum Components, see Apache Project site.

Build Tool is the Maven site building mechanism, though this includes a version it does not contain released sources to be published and versioning of this component is just for convenience (or unavoidable in pom.xml). Nevertheless Apache Site management rules apply.

Publishing

This is described in section Git Checkout source. Generate and Publish Site here:

https://github.com/apache/turbine-fulcrum-build#git-checkout--source-generate-and-publish-site

The basic mechanism is explained here.

Deprecated SCM-Publish Maven Mechanism

Important: Using scm-publish Plugin for publishing is not yet tested for current Apache GIT.

Check first, that turbine.site.path matches the target pubScmUrl (e.g. by investigating the result of mvn help:effective-pom)

Once you have the site checked out locally, cd into your fulcrum-site directory and execute:

mvn site

This will build the documentation into the target/site/ directory. The output will show you which files got re-generated.

If you would like to make modifications to the web site documents, you simply need to edit the files in the xdocs/ directory.

Once you have built your documentation and confirmed that your changes are ok, you can check your .xml files back into Subversion.

To test what files would be deleted or updated run:

mvn site:stage scm-publish:publish-scm -Dscmpublish.dryRun=true

To deploy the site execute:

mvn site:stage scm-publish:publish-scm

To do this you need an account on the people.apache.org machine!!