inteligr8/alfresco-sdk
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-sdk.git synced 2025-08-07 17:49:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

maven site various fixes, mostly links

Browse Source 
git-svn-id: http://maven-alfresco-archetypes.googlecode.com/svn/trunk@637 04253f4f-3451-0410-a141-5562f1e59037
This commit is contained in:
maoo
2012-11-04 23:43:15 +00:00
parent 830df696c5
commit dc1b95cb08
19 changed files with 122 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
archetypes/alfresco-allinone-archetype/src/site/apt/advanced-usage.apt.vm
View File

@@ -1,5 +1,5 @@
------ ------
Alfresco Maven AMP Archetype Advanced Usage Alfresco Maven All-in-One Archetype Advanced Usage
------ ------
Gabriele Columbro Gabriele Columbro
------ ------
@@ -23,7 +23,7 @@ All-in-One Archetype properties
* <<<src/test/properties/<env>/alfresco-global.properties>>> (environment dependent <<<alfresco-global.properties>>> for test WAR run) * <<<src/test/properties/<env>/alfresco-global.properties>>> (environment dependent <<<alfresco-global.properties>>> for test WAR run)
Build Environment (e.g. local, test, staging, prod) can be easily switched by setting the <<<<env>>>> property in yoru POM or Build Environment (e.g. local, test, staging, prod) can be easily switched by setting the <<<<env>>>> property in your POM or
adding <<<-Denv=yourEnv>>> on the command line. adding <<<-Denv=yourEnv>>> on the command line.
* Common properties * Common properties

4
archetypes/alfresco-allinone-archetype/src/site/apt/index.apt.vm
View File

@@ -6,7 +6,7 @@
Nov 2012 Nov 2012
------ ------
Alfresco All-in-One Archetype - Part of the Maven Alfresco SDK\x99 Introduction
The Alfresco All-in-One Archetype is a multi-module project, The Alfresco All-in-One Archetype is a multi-module project,
leveraging Maven Alfresco SDK\x99 powerful capabilities to customize and run the full Alfresco platform embedded and all it's components. leveraging Maven Alfresco SDK\x99 powerful capabilities to customize and run the full Alfresco platform embedded and all it's components.
@@ -45,4 +45,4 @@ mvn archetype:generate -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/c
Usage Usage
Instructions on how to use the Alfresco AMP archetype can be found on the {{{./usage.html}usage page}}, while Instructions on how to use the Alfresco AMP archetype can be found on the {{{./usage.html}usage page}}, while
for more advanced use cases refer to the {{{./advanced-usage.html}usage page}} for more advanced use cases refer to the {{{./advanced-usage.html}advanced usage page}}

12
archetypes/alfresco-allinone-archetype/src/site/apt/usage.apt.vm
View File

@@ -1,5 +1,5 @@
------ ------
Alfresco Maven AMP Archetype Usage Alfresco Maven All-in-One Archetype Usage
------ ------
Gabriele Columbro Gabriele Columbro
------ ------
@@ -8,7 +8,7 @@
Prerequisites Prerequisites
See {{{/prerequisites.html} SDK Pre-Requisites}} to successfully run this archetype. See {{{../../prerequisites.html} SDK Pre-Requisites}} to successfully run this archetype.
Project layout Project layout
@@ -58,7 +58,7 @@ Usage
* release and distribution * release and distribution
for all the components of the Alfresco landscape. for all the components of the Alfresco landscape. For more information, check the See the {{{./advanced-usage.html}advanced usage page}} page.
<<NOTE>>: AMPs produced with this project are fully compatible with Alfresco MMT,in fact the Alfresco Maven plugin - used to manage AMPs in this SDK - embeds the official Alfresco MMT to install depended AMPs. <<NOTE>>: AMPs produced with this project are fully compatible with Alfresco MMT,in fact the Alfresco Maven plugin - used to manage AMPs in this SDK - embeds the official Alfresco MMT to install depended AMPs.
@@ -68,7 +68,7 @@ Commands
Common Alfresco project lifecycle commands you want to run from the aggregator : Common Alfresco project lifecycle commands you want to run from the aggregator :
* <<<mvn package>>>: Runs unit tests and packages all customized modules in their respective \${project.build.directory}/\${project.build.finalName}.amp * <<<mvn package>>>: Runs unit tests and packages all customized modules in their respective <<<$\{project.build.directory\}/$\{project.build.finalName\}.amp>>>
* <<<mvn install>>>: Like <<<mvn package>>> but also installs all modules in local Maven repository to be depended upon * <<<mvn install>>>: Like <<<mvn package>>> but also installs all modules in local Maven repository to be depended upon
@@ -81,7 +81,3 @@ Commands
* Commands from from the <<<runner>>> project * Commands from from the <<<runner>>> project
* <<<mvn jetty:run -Prun'>>> or <<<'mvn integration-test -Prun'>>> to quickly run already packaged webapps * <<<mvn jetty:run -Prun'>>> or <<<'mvn integration-test -Prun'>>> to quickly run already packaged webapps
Advanced usage
See the {{{./advanced-usage.html}advanced usage page}}

14
archetypes/alfresco-allinone-archetype/src/site/site.xml
View File

@@ -2,19 +2,19 @@
<body> <body>
<menu ref="parent" inherit="bottom"/> <menu ref="parent" inherit="bottom"/>
<menu name="Alfresco AMP Archetype"> <menu name="Alfresco All-in-One Archetype">
<item name="Introduction" href="index.html"/> <item name="Introduction" href="index.html"/>
<item name="Usage" href="usage.html"/> <item name="Usage" href="usage.html"/>
<item name="Advanced Usage" href="advanced-usage.html"/> <item name="Advanced Usage" href="advanced-usage.html"/>
</menu> </menu>
<menu name="Maven Alfresco SDK"> <menu name="SDK components">
<item name="Home" href="/index.html" /> <item name="Maven Alfresco SDK" href="../../index.html" />
<item name="Maven Alfresco SDK Prerequisites" href="/prerequisites.html" /> <item name="Alfresco AMP Archetype" href="../alfresco-amp-archetype/index.html" />
<item name="Why using SDK?" href="/why.html" /> <item name="Alfresco All-in-One Archetype" href="./index.html" />
<item name="Alfresco SDK Parent POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/poms/alfresco-sdk-parent/index.html" /> <item name="Alfresco SDK Parent POM" href="../../poms/alfresco-sdk-parent/index.html" />
<item name="Alfresco Platform Distribution POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest/index.html" /> <item name="Alfresco Platform Distribution POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest/index.html" />
<item name="Maven AMP Plugin" href="http://maven.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/plugins/maven-amp-plugin/index.html" /> <item name="Alfresco Maven Plugin" href="../../plugins/alfresco-maven-plugin/index.html" />
</menu> </menu>
<menu name="Maven Alfresco Community"> <menu name="Maven Alfresco Community">

7
archetypes/alfresco-amp-archetype/src/site/apt/advanced-usage.apt.vm
View File

@@ -40,7 +40,10 @@ AMP Archetype properties
<project> <project>
... ...
<properties> <properties>
<!-- Determines the target WAR for this AMP. Allowed values: alfresco | share . Defaults to an 'alfresco' AMP --> <!--
Determines the target WAR for this AMP
Allowed values: alfresco (default) | share
-->
<alfresco.client.war>alfresco</alfresco.client.war> <alfresco.client.war>alfresco</alfresco.client.war>
</properties> </properties>
... ...
@@ -50,7 +53,7 @@ AMP Archetype properties
Parent POM and behavior customization Parent POM and behavior customization
To customize the behavior of your project, check out full set of the properties and plugin configurations defined in the To customize the behavior of your project, check out full set of the properties and plugin configurations defined in the
{{{./poms/alfresco-sdk-parent/index.html}single entry point parent POM}}. {{{../../poms/alfresco-sdk-parent/index.html}single entry point parent POM}}.
One quick way to do that is to use the <<<maven-help-plugin:effective-pom>>> to analyze your POM at runtime. One quick way to do that is to use the <<<maven-help-plugin:effective-pom>>> to analyze your POM at runtime.

2
archetypes/alfresco-amp-archetype/src/site/apt/index.apt.vm
View File

@@ -6,7 +6,7 @@
Nov 2012 Nov 2012
------ ------
Alfresco AMP Archetype - Part of the Maven Alfresco SDK\x99 Introduction
The Alfresco AMP Archetype is a sample fully featured project to manage AMP (Alfresco Module Package) projects. The Alfresco AMP Archetype is a sample fully featured project to manage AMP (Alfresco Module Package) projects.
This archetype can be used both for Alfresco Repository and Alfresco Share AMPs. This archetype can be used both for Alfresco Repository and Alfresco Share AMPs.

14
archetypes/alfresco-amp-archetype/src/site/apt/usage.apt.vm
View File

@@ -9,7 +9,7 @@
Prerequisites Prerequisites
See {{{/prerequisites.html} SDK Pre-Requisites}} to successfully run this archetype. See {{{../../prerequisites.html}SDK Pre-Requisites}} to successfully run this archetype.
Project layout Project layout
@@ -33,7 +33,7 @@ Project layout
+---+ +---+
Basically by default the folder <<<src/main/amp>>> maps the {{{https://wiki.alfresco.com/wiki/AMP_Files#The_structure_of_an_AMP_file}AMP structure}} and it's where you can build your module. Basically by default the folder <<<src/main/amp>>> maps the {{{https://wiki.alfresco.com/wiki/AMP_Files#The_structure_of_an_AMP_file}AMP structure}} and it's where you can build your module.
Usage Usage
@@ -47,9 +47,7 @@ Usage
* integration testing * integration testing
* release and distribution * release and distribution of your AMP artifact.
of your AMP artifact.
The AMPs produced with this project are fully compatible with Alfresco MMT, in fact the Alfresco Maven plugin used to manage AMPs in this SDK embeds the official Alfresco MMT to install depdended AMPs. The AMPs produced with this project are fully compatible with Alfresco MMT, in fact the Alfresco Maven plugin used to manage AMPs in this SDK embeds the official Alfresco MMT to install depdended AMPs.
@@ -57,7 +55,7 @@ Commands
Common AMP project lifecycle commands you want to run are: Common AMP project lifecycle commands you want to run are:
* <<<mvn package>>>: Runs unit tests and packages AMP in \${project.build.directory}/\${project.build.finalName}.amp * <<<mvn package>>>: Runs unit tests and packages AMP in <<<$\{project.build.directory\}/$\{project.build.finalName\}.amp>>>
* <<<mvn install>>>: Like <<<mvn package>>> but also installs AMP in local Maven repository to be depended upon * <<<mvn install>>>: Like <<<mvn package>>> but also installs AMP in local Maven repository to be depended upon
@@ -68,7 +66,7 @@ Commands
* <<<mvn integration-test -Pamp-to-war>>> Like <<<mvn package -Pamp-to-war>>> * <<<mvn integration-test -Pamp-to-war>>> Like <<<mvn package -Pamp-to-war>>>
but also runs the resulting WAR+AMP in Jetty + H2 embedded for integration testing but also runs the resulting WAR+AMP in Jetty + H2 embedded for integration testing
* <<<mvn integration-test -Pamp-to-war -Dalfresco.client.war=share>>>: Like <<<mvn integration-test -Pamp-to-war>>> but installs the AMP and runs on the Share WAR in Jetty embeded. * <<<mvn integration-test -Pamp-to-war -Dalfresco.client.war=share>>>: Like <<<mvn integration-test -Pamp-to-war>>> but installs the AMP and runs on the Share WAR in Jetty embedded.
* <<<mvn clean -Ppurge>>>: Removes DB, alf_data, indexes and log files. Useful to purge the development repo (by default self contained in <<<\${project.basedir}/alf_data_dev>>> * <<<mvn clean -Ppurge>>>: Removes DB, alf_data, indexes and log files. Useful to purge the development repo (by default self contained in <<<$\{project.basedir\}/alf_data_dev>>>

16
archetypes/alfresco-amp-archetype/src/site/site.xml
View File

@@ -8,14 +8,13 @@
<item name="Advanced Usage" href="advanced-usage.html"/> <item name="Advanced Usage" href="advanced-usage.html"/>
</menu> </menu>
<menu name="Maven Alfresco SDK"> <menu name="SDK components">
<item name="Home" href="/index.html" /> <item name="Maven Alfresco SDK" href="../../index.html" />
<item name="Maven Alfresco SDK Prerequisites" href="../../prerequisites.html" /> <item name="Alfresco AMP Archetype" href="./index.html" />
<item name="Maven Alfresco SDK Properties" href="/poms/alfresco-sdk-parent/sdk-properties.html" /> <item name="Alfresco All-in-One Archetype" href="../alfresco-allinone-archetype/index.html" />
<item name="Why using SDK?" href="/why.html" /> <item name="Alfresco SDK Parent POM" href="../../poms/alfresco-sdk-parent/index.html" />
<item name="Alfresco SDK Parent POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/poms/alfresco-sdk-parent/index.html" /> <item name="Alfresco Platform Distribution POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest/index.html" />
<item name="Alfresco Platform Distribution POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest/index.html" /> <item name="Alfresco Maven Plugin" href="../../plugins/alfresco-maven-plugin/index.html" />
<item name="Maven AMP Plugin" href="http://maven.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/plugins/maven-amp-plugin/index.html" />
</menu> </menu>
<menu name="Maven Alfresco Community"> <menu name="Maven Alfresco Community">
@@ -28,6 +27,7 @@
<item name="Enterprise adoption" href="http://www.slideshare.net/guest67a9ba/maven-application-lifecycle-management-for-alfresco" /> <item name="Enterprise adoption" href="http://www.slideshare.net/guest67a9ba/maven-application-lifecycle-management-for-alfresco" />
</menu> </menu>
<!-- maybe it's inherited? -->
<!--<menu ref="reports"/>--> <!--<menu ref="reports"/>-->
</body> </body>

4
plugins/alfresco-maven-plugin/src/site/apt/index.apt.vm
View File

@@ -6,7 +6,7 @@
Nov 2012 Nov 2012
------ ------
Alfresco Maven Plugin - Part of the Maven Alfresco SDK\x99 Introduction
The Alfresco Maven Plugin provides development features to manage {{{http://www.alfresco.com}Alfresco ECM}} WAR and {{{https://wiki.alfresco.com/wiki/AMP_Files}AMP}} project lifecycles. The Alfresco Maven Plugin provides development features to manage {{{http://www.alfresco.com}Alfresco ECM}} WAR and {{{https://wiki.alfresco.com/wiki/AMP_Files}AMP}} project lifecycles.
@@ -20,6 +20,8 @@ Alfresco Maven Plugin - Part of the Maven Alfresco SDK\x99
*{{{./version-mojo.html}alfresco:version}} Parses ${project.version} removing literals (for AMP compatibility) and making the ${noSnapshot} property available in the POM *{{{./version-mojo.html}alfresco:version}} Parses ${project.version} removing literals (for AMP compatibility) and making the ${noSnapshot} property available in the POM
More info in the {{{./plugin-info.html}goals page}}.
* Usage * Usage
General instructions on how to use the Alfresco Maven Plugin can be found on the {{{./usage.html}usage page}}. General instructions on how to use the Alfresco Maven Plugin can be found on the {{{./usage.html}usage page}}.

23
plugins/alfresco-maven-plugin/src/site/site.xml
View File

@@ -1,8 +1,8 @@
<project> <project>
<body> <body>
<menu ref="parent" inherit="bottom"/> <!--<menu ref="parent" inherit="bottom"/>-->
<menu name="Plugin info"> <menu name="Alfresco Maven Plugin">
<item name="Introduction" href="index.html"/> <item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/> <item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/> <item name="Usage" href="usage.html"/>
@@ -10,20 +10,13 @@
<item name="Plexus Components" href="plexus-components.html"/> <item name="Plexus Components" href="plexus-components.html"/>
</menu> </menu>
<menu name="Archetypes using this plugin"> <menu name="SDK components">
<!-- @TODO update href --> <item name="Maven Alfresco SDK" href="../../index.html" />
<item name="Maven Alfresco AMP Archetype" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/archetypes/alfresco-amp-archetype/index.html"/> <item name="Alfresco AMP Archetype" href="../alfresco-amp-archetype/index.html" />
<item name="Maven Alfresco All In One Archetype" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/archetypes/alfresco-allinone-archetype/index.html"/> <item name="Alfresco All-in-One Archetype" href="./index.html" />
</menu> <item name="Alfresco SDK Parent POM" href="../../poms/alfresco-sdk-parent/index.html" />
<menu name="Maven Alfresco SDK">
<item name="Home" href="/index.html" />
<item name="Maven Alfresco SDK Prerequisites" href="../../prerequisites.html" />
<item name="Maven Alfresco SDK Properties" href="/poms/alfresco-sdk-parent/sdk-properties.html" />
<item name="Why using SDK?" href="/why.html" />
<item name="Alfresco SDK Parent POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/poms/alfresco-sdk-parent/index.html" />
<item name="Alfresco Platform Distribution POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest/index.html" /> <item name="Alfresco Platform Distribution POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest/index.html" />
<item name="Maven AMP Plugin" href="http://maven.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/plugins/maven-amp-plugin/index.html" /> <item name="Alfresco Maven Plugin" href="../../plugins/alfresco-maven-plugin/index.html" />
</menu> </menu>
<menu name="Maven Alfresco Community"> <menu name="Maven Alfresco Community">

2
pom.xml
View File

@@ -5,7 +5,7 @@
<groupId>org.alfresco.maven</groupId> <groupId>org.alfresco.maven</groupId>
<artifactId>alfresco-lifecycle-aggregator</artifactId> <artifactId>alfresco-lifecycle-aggregator</artifactId>
<version>1.0-SNAPSHOT</version> <version>1.0-SNAPSHOT</version>
<name>Maven Alfresco SDK Lifecycle Aggregator</name> <name>Maven Alfresco SDK™</name>
<description>This aggregator Project builds all modules required for the Maven Alfresco SDK</description> <description>This aggregator Project builds all modules required for the Maven Alfresco SDK</description>
<packaging>pom</packaging> <packaging>pom</packaging>

6
poms/alfresco-sdk-parent/pom.xml
View File

@@ -95,6 +95,7 @@
<!-- Maven Plugins Versions used by the SDK --> <!-- Maven Plugins Versions used by the SDK -->
<maven.compiler.version>2.3.2</maven.compiler.version> <maven.compiler.version>2.3.2</maven.compiler.version>
<maven.clean.version>2.4.1</maven.clean.version> <maven.clean.version>2.4.1</maven.clean.version>
<maven.site.version>3.2</maven.site.version>
<maven.dependency.version>2.4</maven.dependency.version> <maven.dependency.version>2.4</maven.dependency.version>
<maven.enforcer.plugin>1.1.1</maven.enforcer.plugin> <maven.enforcer.plugin>1.1.1</maven.enforcer.plugin>
<maven.resources.version>2.5</maven.resources.version> <maven.resources.version>2.5</maven.resources.version>
@@ -173,6 +174,11 @@
<snapshotToTimestamp>true</snapshotToTimestamp> <snapshotToTimestamp>true</snapshotToTimestamp>
</configuration> </configuration>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>${maven.site.version}</version>
</plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId> <artifactId>maven-compiler-plugin</artifactId>

8
poms/alfresco-sdk-parent/src/site/apt/index.apt.vm
View File

@@ -6,12 +6,12 @@
Nov 2012 Nov 2012
------ ------
Alfresco SDK Parent - Part of Maven Alfresco SDK\x99 Introduction
The Alfresco SDK Parent POM ${project.version} is the <<<single entry point>>> for all Maven Alfresco SDK\x99 features. The Alfresco SDK Parent POM ${project.version} is the <<<single entry point>>> for all Maven Alfresco SDK\x99 features.
It aggregates plugin configurations and dependencies to provide a set of profiles and properties to manage the full Alfresco projects Lifecycle on Maven. It aggregates plugin configurations and dependencies to provide a set of profiles and properties to manage the full Alfresco projects Lifecycle on Maven.
The current version of the POM in use in the Maven Alfresco SDK\x99 ${project.version} is available {{{${scm.tags.url}/poms/alfresco-sdk-parent/pom.xml} here}}. The current version of the POM in use in the Maven Alfresco SDK\x99 ${project.version} is available {{{https://artifacts.alfresco.com/nexus/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}on Alfresco Maven Repository}}.
Usage Usage
@@ -33,9 +33,9 @@ Usage
Full dependency information for other build systems can be found in the {{{./dependency-info.html} Dependency Info page}}. Full dependency information for other build systems can be found in the {{{./dependency-info.html} Dependency Info page}}.
Features are provided in terms of {{{./sdk-profiles.html} Maven profiles}}, and high configurability is provided with Features are provided in terms of {{{./sdk-profiles.html} Maven profiles}}, and high configurability is provided with
{{{./sdk-properties}POM properties}} avaialble to sibling projects. {{{./sdk-properties.html}POM properties}} avaialble to sibling projects.
* Examples / archetypes * Examples / archetypes
To kickstart your SDK experience and to provide examples on how to use it, archetypes are available already using this POM. To kickstart your SDK experience and to provide examples on how to use it, archetypes are available already using this POM.
Check the menu item <Projects using this POM> or the {{{/index.html}SDK Home Page}} for more samples. Check the menu item <SDK Components> for more samples.

11
poms/alfresco-sdk-parent/src/site/apt/sdk-profiles.apt.vm
View File

@@ -10,28 +10,31 @@ SDK Available Profiles
The Maven Alfresco SDK\x99 defines common features required by different Alfresco projects. The Maven Alfresco SDK\x99 defines common features required by different Alfresco projects.
While the <<<recommended>>> way is to use full working examples of usage of these profiles (e.g. the While the <<<recommended>>> way is to use full working examples of usage of these profiles (e.g. the
{{{./archetypes/alfresco-amp-archetype/index.html}AMP}} and {{{./archetypes/alfresco-allinone-archetype/index.html}All-in-One}} archetypes), {{{../../archetypes/alfresco-amp-archetype/index.html}AMP}} and {{{../../archetypes/alfresco-allinone-archetype/index.html}All-in-One}} archetypes),
you can also directly use this POM as a parent in your custom project. you can also directly use this POM as a parent in your custom project.
Here goes the list of common used profiles (with their activation conditions): Here goes the list of common used profiles (with their activation conditions):
*-----------+--------------+-------------+-------------+ *-----------+--------------+-------------+-------------+
|| Profile || Description || Activation | |Phase | || Profile || Description || Activation || Phase |
*-----------+--------------+-------------+-------------+ *-----------+--------------+-------------+-------------+
| amp-to-war | Allows AMP projects to be run embedded on a WAR | Manual: <<<-Pamp-to-war>>> | integration-test | | amp-to-war | Allows AMP projects to be run embedded on a WAR | Manual: <<<-Pamp-to-war>>> | integration-test |
*-----------*--------------*-------------*-------------*
| purge | Cleans all alf_data and logs from Alfresco runs | Manual: <<<-Ppurge>>> | clean | | purge | Cleans all alf_data and logs from Alfresco runs | Manual: <<<-Ppurge>>> | clean |
*-----------*--------------*-------------*-------------*
| enable-amp-testing | Allows AMP unit testing | Automatic if <<<src/test/java>>> is present | test | | enable-amp-testing | Allows AMP unit testing | Automatic if <<<src/test/java>>> is present | test |
*-----------*--------------*-------------*-------------*
| enable-amp | Activates AMP packaging | Automatic if <<<src/main/amp/modules.properties>>> is present | test | | enable-amp | Activates AMP packaging | Automatic if <<<src/main/amp/modules.properties>>> is present | test |
*-----------+--------------+-------------+-------------+ *-----------+--------------+-------------+-------------+
The full list of available profiles (with their activation conditions) can be instead found in the <<<profiles>>> section of the The full list of available profiles (with their activation conditions) can be instead found in the <<<profiles>>> section of the
{{{${scm.tags.url}/poms/alfresco-sdk-parent/pom.xml} <20>lfresco SDK POM}}. {{{https://artifacts.alfresco.com/nexus/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}Alfresco SDK POM}}.
Full SDK properties reference Full SDK properties reference
The full reference of properties defined in the SDK can be obtained by looking The full reference of properties defined in the SDK can be obtained by looking
at the <<<properties>>> section of the current version of the <<<alfresco-sdk-parent>>> in use. at the <<<properties>>> section of the current version of the <<<alfresco-sdk-parent>>> in use.
Check the {{{${scm.tags.url}/poms/alfresco-sdk-parent/pom.xml} current POM version}} for this. Check the {{{https://artifacts.alfresco.com/nexus/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}current POM version}} for this.
While in certain cases it might be useful to override defaults, make sure you know what you're doing, While in certain cases it might be useful to override defaults, make sure you know what you're doing,
as you might be <<breaking>> SDK conventions and therefore <<your build>>> as you might be <<breaking>> SDK conventions and therefore <<your build>>>

18
poms/alfresco-sdk-parent/src/site/apt/sdk-properties.apt.vm
View File

@@ -39,7 +39,23 @@ Full SDK properties reference
The full reference of properties defined in the SDK can be obtained by looking The full reference of properties defined in the SDK can be obtained by looking
at the <<<properties>>> section of the current version of the <<<alfresco-sdk-parent>>> in use. at the <<<properties>>> section of the current version of the <<<alfresco-sdk-parent>>> in use.
Check the {{{${scm.tags.url}/poms/alfresco-sdk-parent/pom.xml} current POM version}} for this. Check the {{{https://artifacts.alfresco.com/nexus/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}current POM version}} for this.
While in certain cases it might be useful to override defaults, make sure you know what you're doing, While in certain cases it might be useful to override defaults, make sure you know what you're doing,
as you might be <<breaking>> SDK conventions and therefore <<your build>>> as you might be <<breaking>> SDK conventions and therefore <<your build>>>
Example - Configuring custom DB
In order to configure a given JDBC database connection, you need to define some POM properties.
+---+
<properties>
...
<alfresco.db.name>alfresco</alfresco.db.name>
<alfresco.db.username>alfresco</alfresco.db.username>
<alfresco.db.password>alfresco</alfresco.db.password>
<alfresco.db.params></alfresco.db.params>
<alfresco.db.url>jdbc:mysql://${db.host}:${db.port}/${db.name}</alfresco.db.url>
<alfresco.db.datasource.class>org.gjt.mm.mysql.Driver</alfresco.db.datasource.class>
</properties>
+---+

24
poms/alfresco-sdk-parent/src/site/site.xml
View File

@@ -33,30 +33,23 @@
<body> <body>
<menu ref="modules" inherit="bottom"/> <!--<menu ref="modules" inherit="bottom"/>-->
<menu ref="parent" inherit="bottom"/> <menu ref="parent" inherit="bottom"/>
<menu name="Maven Alfresco SDK Parent POM"> <menu name="SDK Parent POM">
<item name="Introduction" href="./index.html" /> <item name="Introduction" href="./index.html" />
<item name="Maven Alfresco SDK Properties" href="./sdk-properties.html" /> <item name="Maven Alfresco SDK Properties" href="./sdk-properties.html" />
<item name="Maven Alfresco SDK Profiles" href="./sdk-profiles.html" /> <item name="Maven Alfresco SDK Profiles" href="./sdk-profiles.html" />
</menu> </menu>
<menu name="Projects using this POM"> <menu name="SDK components">
<item name="Maven Alfresco SDK" href="../../index.html" />
<item name="Alfresco AMP Archetype" href="../../archetypes/alfresco-amp-archetype/index.html" /> <item name="Alfresco AMP Archetype" href="../../archetypes/alfresco-amp-archetype/index.html" />
<item name="Alfresco All-in-One Archetype" href="../../archetypes/alfresco-allinone-archetype/index.html" /> <item name="Alfresco All-in-One Archetype" href="../../archetypes/alfresco-allinone-archetype/index.html" />
</menu> <item name="Alfresco SDK Parent POM" href="./index.html" />
<menu name="Maven Alfresco SDK">
<item name="Home" href="/index.html" />
<item name="Maven Alfresco SDK Prerequisites" href="../../prerequisites.html" />
<item name="Maven Alfresco SDK Properties" href="../../poms/alfresco-sdk-parent/sdk-properties.html" />
<item name="Why using SDK?" href="../../why.html" />
<item name="Alfresco SDK Parent POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/poms/alfresco-sdk-parent/index.html" />
<item name="Alfresco Platform Distribution POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest/index.html" /> <item name="Alfresco Platform Distribution POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest/index.html" />
<item name="Maven AMP Plugin" href="http://maven.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/plugins/maven-amp-plugin/index.html" /> <item name="Alfresco Maven Plugin" href="../../plugins/alfresco-maven-plugin/index.html" />
</menu> </menu>
<menu name="Maven Alfresco Community"> <menu name="Maven Alfresco Community">
@@ -70,10 +63,5 @@
</menu> </menu>
<menu ref="reports" /> <menu ref="reports" />
<links>
<item name="Alfresco" href="http://www.alfresco.com/" />
<item name="Apache Maven" href="http://maven.apache.org/" />
</links>
</body> </body>
</project> </project>

21
src/site/apt/index.apt.vm
View File

@@ -6,18 +6,23 @@
Nov 2012 Nov 2012
------ ------
Maven Alfresco SDK\x99 Introduction
The Alfresco Maven SDK ${project.version} - formerly {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/} Maven Alfresco Lifecycle 3.9.1}} - The Alfresco Maven SDK ${project.version} - formerly {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/index.html} Maven Alfresco Lifecycle 3.9.1}} -
provides a fully fledged Maven support for {{{http://www.alfresco.com}Alfresco ECM}} WAR and {{{https://wiki.alfresco.com/wiki/AMP_Files}AMP}} project development. provides a fully fledged Maven support for {{{http://www.alfresco.com}Alfresco ECM}} WAR and {{{https://wiki.alfresco.com/wiki/AMP_Files}AMP}} project development.
Being fully integrated with Maven it allows to both leverage the vast number of Maven plugins for your Alfresco project as well as integrated your Being fully integrated with Maven it allows to both leverage the vast number of Maven plugins for your Alfresco project as well as integrated your
project easily in Open Source and Enterprise development processes. project easily in Open Source and Enterprise development processes.
* Maven Alfresco SDK\x99 components The Alfresco Maven SDK introduces a new way of conceiving software development, deployment and release around Alfresco-related artifacts.
In contrast to the usual monolithic deployment approach of Tomcat installer and/or Alfresco WAR distribution(s), the new SDK grants access to an Artifact (jar,war,pom files) that can be accessed by Alfresco-specific Maven components and configurations, but also enables the development of very custom build behaviour and rapid development practices (i.e. TDD, FDD)
The Maven Alfresco SDK\x99 is fully documented in the single components websites (links above) as well as updated on {{{https://wiki.alfresco.com/wiki/Maven_Alfresco_SDK}the Alfresco Wiki}}.
* Maven Alfresco SDK\x99 components
The Maven Alfresco SDK relies on a number of components: The Maven Alfresco SDK relies on a number of components:
* {{{./poms/alfresco-sdk-parent/index.html}An SDK POM}} providing full Alfresco project lifecycle feature, to be added as a <<<<parent>>>> in your projects * {{{./poms/alfresco-sdk-parent/index.html}The SDK parent POM}} providing full Alfresco project lifecycle feature, to be added as a <<<<parent>>>> in your projects
* Archetypes like the {{{./archetypes/alfresco-amp-archetype/index.html}AMP}} or {{{./archetypes/alfresco-allinone-archetype/index.html}All-in-One}} providing sample project to kickstart your Alfresco development and boost it with best practices * Archetypes like the {{{./archetypes/alfresco-amp-archetype/index.html}AMP}} or {{{./archetypes/alfresco-allinone-archetype/index.html}All-in-One}} providing sample project to kickstart your Alfresco development and boost it with best practices
@@ -27,10 +32,6 @@ Maven Alfresco SDK\x99
* The {{{https://artifacts.alfresco.com}Alfresco Artifacts Repository}} provides backing for this SDK. Check the {{{http://wiki.alfresco.com/wiki/Alfresco_Artifacts_Repository}Alfresco Wiki}} for Community / Enterprise access information. * The {{{https://artifacts.alfresco.com}Alfresco Artifacts Repository}} provides backing for this SDK. Check the {{{http://wiki.alfresco.com/wiki/Alfresco_Artifacts_Repository}Alfresco Wiki}} for Community / Enterprise access information.
* Usage
The Maven Alfresco SDK\x99 is fully documented in the single components websites (links above) as well as updated on {{{https://wiki.alfresco.com/wiki/Maven_Alfresco_SDK}the Alfresco Wiki}}.
* Pre-requisites * Pre-requisites
** System prerequisites ** System prerequisites
@@ -50,6 +51,6 @@ Project History
* The Maven Alfresco SDK\x99 reached its version ${project.version}. * The Maven Alfresco SDK\x99 reached its version ${project.version}.
* The project was formerly called Maven Alfresco Lifecycle (up to version 3.9.1), and has been re-branded to reflect a major restructuring and a better Alfresco support, * The project was formerly called Maven Alfresco Lifecycle (up to version 3.9.1), and has been re-branded to reflect a major restructuring and a better Alfresco support,
with the availability of Alfresco Community / Enterprise artifacts and {{{https://issues.alfresco.com/jira/browse/ALF-14353}POMs}} in the {{{https://artifacts.alfresco.com}Alfresco Artifacts Repository}}. with the {{{https://issues.alfresco.com/jira/browse/ALF-14353}availability of Alfresco Community/Enterprise artifacts and POMs}} in the {{{https://artifacts.alfresco.com}Alfresco Artifacts Repository}}.
* Other names used for this project: Maven Alfresco Archetypes, Maven Alfresco Plugin, Maven Alfresco Support. Any more suggestions? :) * The current effort is also known as Maven Alfresco Archetypes, Alfresco Maven Plugin or Maven Alfresco Support.

5
src/site/apt/prerequisites.apt.vm
View File

@@ -15,7 +15,7 @@ Maven Alfresco SDK\x99 Pre-Requisites
Additional tips: Additional tips:
* It is strongly advised to use the Apache Maven official binary distributions downloaded from the {{http://maven.apache.org}official mirrors}}; avoid OS-specific distributions as much as possible. * It is strongly advised to use the Apache Maven official binary distributions downloaded from the {{{http://maven.apache.org}official mirrors}}; avoid OS-specific distributions as much as possible.
* add <<<MAVEN_OPTS="-Xms256m -Xmx1G -XX:PermSize=300m">>> to your environment if your plan to launch tests / run embedded in Jetty * add <<<MAVEN_OPTS="-Xms256m -Xmx1G -XX:PermSize=300m">>> to your environment if your plan to launch tests / run embedded in Jetty
@@ -34,3 +34,6 @@ H2 Embedded Support Pre-Requisites
Maven Alfresco SDK\x99 ${project.version} uses version 1.5 of the Alfresco H2 Support. In case you experience Maven Alfresco SDK\x99 ${project.version} uses version 1.5 of the Alfresco H2 Support. In case you experience
issues with the embedded DB support, please check the {{{https://github.com/skuro/alfresco-h2-support/wiki/H2-Database-support-for-Alfresco} H2 Support Compatibility matrix}}. issues with the embedded DB support, please check the {{{https://github.com/skuro/alfresco-h2-support/wiki/H2-Database-support-for-Alfresco} H2 Support Compatibility matrix}}.
Alternatively, you can easily setup your DB access by defining {{{./poms/alfresco-sdk-parent/sdk-properties.html}POM properties}}

13
src/site/site.xml
View File

@@ -37,14 +37,17 @@
<menu name="Maven Alfresco SDK"> <menu name="Maven Alfresco SDK">
<item name="Introduction" href="index.html"/> <item name="Introduction" href="index.html"/>
<item name="Maven Alfresco SDK Prerequisites" href="prerequisites.html" /> <item name="Maven Alfresco SDK Prerequisites" href="prerequisites.html" />
<item name="Maven Alfresco SDK Properties" href="./poms/alfresco-sdk-parent/sdk-properties.html" />
<item name="Why using SDK?" href="./why.html" /> <item name="Why using SDK?" href="./why.html" />
<item name="Alfresco SDK Parent POM" href="./poms/alfresco-sdk-parent/index.html" />
<item name="Alfresco Platform Distribution POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest/index.html" />
<item name="Maven AMP Plugin" href="http://maven.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/plugins/maven-amp-plugin/index.html" />
</menu> </menu>
<menu ref="modules" inherit="bottom"/> <menu name="SDK components">
<item name="Maven Alfresco SDK" href="./index.html" />
<item name="Alfresco AMP Archetype" href="./archetypes/alfresco-amp-archetype/index.html" />
<item name="Alfresco All-in-One Archetype" href="./archetypes/alfresco-allinone-archetype/index.html" />
<item name="Alfresco SDK Parent POM" href="./poms/alfresco-sdk-parent/index.html" />
<item name="Alfresco Platform Distribution POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest/index.html" />
<item name="Alfresco Maven Plugin" href="./plugins/alfresco-maven-plugin/index.html" />
</menu>
<menu name="Community Docs"> <menu name="Community Docs">
<item name="Alfresco Maven Wiki Docs" href="http://wiki.alfresco.com/wiki/Maven_Alfresco_SDK" /> <item name="Alfresco Maven Wiki Docs" href="http://wiki.alfresco.com/wiki/Maven_Alfresco_SDK" />