diff --git a/README.md b/README.md index df8b8d37..2235008e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # [![Maven Alfresco SDK logo](https://github.com/Alfresco/alfresco-sdk/raw/master/src/site/resources/img/alfresco-maven-logo.jpg)](#features) Maven Alfresco SDK -The Alfresco SDK based on Apache Maven, includes support for rapid and standard development, testing, packaging, versioning and release of your Alfresco integration and extension projects. +Maven Alfresco SDK for Alfresco Development and Customizations based on Apache Maven. + +Includes support for rapid and standard development, testing, packaging, versioning and release of your Alfresco integration and extension projects. It is composed of: - An [SDK Parent POM](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-lifecycle-aggregator/latest/poms/alfresco-sdk-parent/index.html) which you can use in your projects to enable rapid Alfresco development features - An [Alfresco Platform Distribution POM](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-platform-distribution/latest/index.html) which pre-configures versions of Alfresco and common 3rd party dependency libraries, for stability purposes -- An Alfresco [Maven Plugin](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-lifecycle-aggregator/latest/plugins/alfresco-maven-plugin/index.html) which provides AMP packaging and installation facitilites (a la MMT) and other common goals for Alfresco development +- A [Maven Alfresco Plugin](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-lifecycle-aggregator/latest/plugins/alfresco-maven-plugin/index.html) which provides AMP packaging and installation facilities (a la MMT) and other common goals for Alfresco development - A number of *Maven Archetypes* (sample projects) including: 1. [Alfresco Repository AMP Archetype](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-lifecycle-aggregator/latest/archetypes/alfresco-amp-archetype/index.html) 2. [Alfresco Share AMP Archetype](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-lifecycle-aggregator/latest/archetypes/share-amp-archetype/index.html) @@ -14,38 +16,38 @@ It is composed of: ## Resources -### Developer docs +### Developer Documentation **SDK 2.x**: Full documentation is available at the [Maven Alfresco SDK site](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-sdk-aggregator/latest/index.html). -**SDK 1.x**: Full documentation is available at the [Maven Alfresco SDK site](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-lifecycle-aggregator/latest/index.html). +### Alfresco Official Documentation -### Alfresco Official docs - -Additional documentation for Alfresco Community and Enterprise, tutorials and examples is available in the [Alfresco Docs](http://docs.alfresco.com/4.2/concepts/dev-extensions-maven-sdk-intro.html). +Additional documentation for Alfresco Community and Enterprise, tutorials and examples is available in the [Alfresco Documentation](http://docs.alfresco.com/4.2/concepts/dev-extensions-maven-sdk-intro.html). ### Samples -Advanced sample projects are maintained by @ohej in the [Alfresco SDK Samples project](https://github.com/Alfresco/alfresco-sdk-samples/). +Advanced sample projects are maintained by @ohej in the [Maven Alfresco SDK Samples project](https://github.com/Alfresco/alfresco-sdk-samples/). ### Contribute -Report issues (and contribute!) [here](https://github.com/Alfresco/alfresco-sdk/issues?milestone=1&state=open). You can also join the [Maven Alfresco list on Google Groups](https://groups.google.com/forum/#!forum/maven-alfresco). +Report issues (and contribute!) [here](https://github.com/Alfresco/alfresco-sdk/issues?milestone=1&state=open). You can also join the [Alfresco list on Google Groups](https://groups.google.com/forum/#!forum/maven-alfresco). ## Maven Repositories -The Alfresco Maven SDK is released in Maven Central as of version 2.0-beta-1. Alfresco (Community and Enterprise) artifacts are instead hosted in the [Alfresco Artifacts Repository](https://artifacts.alfresco.com/nexus/). +The Maven Alfresco SDK is released in Maven Central as of version 2.0-beta-1. + +Alfresco (Community and Enterprise) artifacts are instead hosted in the [Alfresco Artifacts Repository](https://artifacts.alfresco.com/nexus/). Alfresco Community artifacts (JARs, WARs, AMPs, poms) and SDK artifacts are publicly available. for Enterprise and Premiere licensed software access you need to get credential via the Alfresco Enterprise Support. See [public docs](http://docs.alfresco.com/4.2/concepts/dev-extensions-maven-sdk-tutorials-alfresco-enterprise.html) or [this KB (login required)](https://myalfresco.force.com/support/articles/en_US/Technical_Article/Where-can-I-find-the-repository-for-Enterprise-Maven-artifacts) for more details. ## License and Support -This project is released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). It's a community driven project which is supported for Alfresco Development (please refere to the official [Alfresco Docs](http://docs.alfresco.com/4.2/concepts/dev-extensions-maven-sdk-intro.html) for supported features. +This project is released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). It's a community driven project which is supported for Alfresco Development (please refere to the official [Alfresco Documentation](http://docs.alfresco.com/4.2/concepts/dev-extensions-maven-sdk-intro.html) for supported features. ## News - 2014-08-22: First SNAPSHOT of SDK 2.0.0 in the [OSS Sonatype Repository](https://oss.sonatype.org/content/repositories/snapshots/org/alfresco/maven/alfresco-sdk-parent/2.0.0-SNAPSHOT/)! -- 2014-07: Project fully migrated from [Google Code](https://code.google.com/p/maven-alfresco-archetypes), including tags, branches, issues. Allow a little time for a full cleanup of issue labels and to sort repository permissions. Please update obsolete references and bear with us as we update Alfresco Docs to this change. +- 2014-07: Project fully migrated from [Google Code](https://code.google.com/p/maven-alfresco-archetypes), including tags, branches, issues. Allow a little time for a full cleanup of issue labels and to sort repository permissions. Please update obsolete references and bear with us as we update Alfresco Documentation to this change. diff --git a/archetypes/alfresco-allinone-archetype/pom.xml b/archetypes/alfresco-allinone-archetype/pom.xml index 43c00474..bb2c17e3 100644 --- a/archetypes/alfresco-allinone-archetype/pom.xml +++ b/archetypes/alfresco-allinone-archetype/pom.xml @@ -5,7 +5,7 @@ org.alfresco.maven.archetype alfresco-allinone-archetype maven-archetype - All-in-One Archetype from Maven Alfresco SDK + Maven Alfresco SDK - All-in-One Archetype Sample multi-module project for All-in-One development on the Alfresco plaftorm. Includes modules for: Repository WAR overlay, Repository AMP, Share WAR overlay, Solr configuration, and embedded Tomcat runner diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/pom.xml b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/pom.xml index 22374930..bd8d5468 100644 --- a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/pom.xml +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/pom.xml @@ -4,7 +4,7 @@ ${groupId} ${artifactId} ${version} - Quickstart of Alfresco and Share with DB and runner embedded + Alfresco Repository and Share Quickstart with database and an embedded runner. This All-in-One project allows to manage all the components involved in Alfresco development (Repo, Share, Solr, AMPs) in one project pom @@ -14,18 +14,18 @@ @@alfresco.sdk.parent.version@@ - + | Defines the groupId for the Alfresco Artifacts to work against. As of 4.2 the only allowed value is: org.alfresco + | NOTE: See http://docs.alfresco.com/4.2/concepts/dev-extensions-maven-sdk-tutorials-alfresco-enterprise.html for details + --> ${alfresco_target_groupId} - ${alfresco_target_version} @@ -39,10 +39,10 @@ - ${alfresco.groupId} diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/pom.xml b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/pom.xml index ae698e46..7f885400 100644 --- a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/pom.xml +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/pom.xml @@ -2,7 +2,7 @@ 4.0.0 ${artifactId} - Alfresco repository AMP Module + Alfresco Repository AMP Module amp This is a sample Alfresco repository AMP project, depended upon by the alfresco WAR module diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/run-spring-loaded.sh b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/run-spring-loaded.sh new file mode 100644 index 00000000..c536a941 --- /dev/null +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/run-spring-loaded.sh @@ -0,0 +1 @@ +MAVEN_OPTS="-javaagent:./lib/springloaded-1.2.0.RELEASE.jar -noverify -Xms256m -Xmx2G -XX:PermSize=300m" mvn integration-test -Pamp-to-war \ No newline at end of file diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/run.sh b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/run.sh new file mode 100644 index 00000000..e5929027 --- /dev/null +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/run.sh @@ -0,0 +1,2 @@ +#!/bin/sh +MAVEN_OPTS="-Xms256m -Xmx2G -XX:PermSize=300m" mvn integration-test -Pamp-to-war diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/src/main/java/org/alfresco/demoamp/Demo.java b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/src/main/java/org/alfresco/demoamp/Demo.java index 8ea79e2a..bf31080a 100644 --- a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/src/main/java/org/alfresco/demoamp/Demo.java +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/src/main/java/org/alfresco/demoamp/Demo.java @@ -2,7 +2,7 @@ package org.alfresco.demoamp; /** * This class does nothing except dump some output to system.out. - * This is a sample taken from Alfresco SDK + * This is a sample taken from Maven Alfresco SDK * * @author Derek Hulley */ diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/src/main/java/org/alfresco/demoamp/DemoComponent.java b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/src/main/java/org/alfresco/demoamp/DemoComponent.java index 3de78f01..de4c2cbb 100644 --- a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/src/main/java/org/alfresco/demoamp/DemoComponent.java +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/src/main/java/org/alfresco/demoamp/DemoComponent.java @@ -8,7 +8,7 @@ import org.apache.commons.logging.LogFactory; /** * A basic component that will be started for this module. - * This is a sample taken from Alfresco SDK + * This is a sample taken from Maven Alfresco SDK * * @author Derek Hulley */ diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo/pom.xml b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo/pom.xml index 70a4ed97..786e6303 100644 --- a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo/pom.xml +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo/pom.xml @@ -9,14 +9,14 @@ 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. --> - - 4.0.0 ${artifactId} - Alfresco Repository and Explorer Client + Alfresco Repository and Explorer Module war - Alfresco Repository and Explorer Client, installs your AMPs in the Alfresco WAR for aggregation purposes + Alfresco Repository and Explorer Module, installs your AMPs in the Alfresco WAR for aggregation purposes ${groupId} diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/pom.xml b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/pom.xml index 6d511acc..3edf8628 100644 --- a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/pom.xml +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/pom.xml @@ -3,9 +3,9 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> 4.0.0 ${artifactId} - Share AMP project + Alfresco Share AMP Module amp - This is a sample Share AMP project, depended upon by the share WAR module + This is a sample Alfresco Share AMP project, depended upon by the share WAR module ${groupId} @@ -30,19 +30,27 @@ http://localhost:8080/alfresco - WARN + WARN - - - org.springframework.extensions.surf - spring-surf-api - provided - + + + ${alfresco.groupId} + share + ${alfresco.version} + classes + provided + + + + org.springframework.extensions.surf + spring-surf-api + provided + diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/run-spring-loaded.sh b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/run-spring-loaded.sh new file mode 100644 index 00000000..10bc9f6a --- /dev/null +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/run-spring-loaded.sh @@ -0,0 +1 @@ +mvn integration-test -Pamp-to-war \ No newline at end of file diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/run.sh b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/run.sh new file mode 100644 index 00000000..1ae1aec1 --- /dev/null +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/run.sh @@ -0,0 +1,2 @@ +#!/bin/sh +mvn integration-test -Pamp-to-war diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share/pom.xml b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share/pom.xml index 82b63dbe..30e888cf 100644 --- a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share/pom.xml +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share/pom.xml @@ -3,9 +3,9 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> 4.0.0 ${artifactId} - Alfresco Share Client + Alfresco Share Module war - Alfresco Share Client + Alfresco Share Module ${groupId} diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/solr/pom.xml b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/solr/pom.xml index b1717345..e34eed4e 100644 --- a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/solr/pom.xml +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/solr/pom.xml @@ -2,7 +2,7 @@ 4.0.0 ${artifactId} - Alfresco Apache Solr customization + Alfresco Apache Solr Customization Module pom Alfresco Apache Solr Customization diff --git a/archetypes/alfresco-allinone-archetype/src/site/apt/advanced-usage.apt.vm b/archetypes/alfresco-allinone-archetype/src/site/apt/advanced-usage.apt.vm index 0b54cc81..3c678984 100644 --- a/archetypes/alfresco-allinone-archetype/src/site/apt/advanced-usage.apt.vm +++ b/archetypes/alfresco-allinone-archetype/src/site/apt/advanced-usage.apt.vm @@ -1,5 +1,5 @@ ------ - Alfresco Maven All-in-One Archetype Advanced Usage + Maven Alfresco All-in-One Archetype Advanced Usage ------ Gabriele Columbro ------ diff --git a/archetypes/alfresco-allinone-archetype/src/site/apt/usage.apt.vm b/archetypes/alfresco-allinone-archetype/src/site/apt/usage.apt.vm index 1798c010..1299af15 100644 --- a/archetypes/alfresco-allinone-archetype/src/site/apt/usage.apt.vm +++ b/archetypes/alfresco-allinone-archetype/src/site/apt/usage.apt.vm @@ -1,5 +1,5 @@ ------ - Alfresco Maven All-in-One Archetype Usage + Maven Alfresco All-in-One Archetype Usage ------ Gabriele Columbro ------ @@ -61,7 +61,7 @@ Usage for all the components of the Alfresco landscape. For more information, check the See the {{{./advanced-usage.html}advanced usage page}} page. - <>: 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. + <>: AMPs produced with this project are fully compatible with Alfresco MMT,in fact the Maven Alfresco plugin - used to manage AMPs in this SDK - embeds the official Alfresco MMT to install depended AMPs. Commands diff --git a/archetypes/alfresco-allinone-archetype/src/site/site.xml b/archetypes/alfresco-allinone-archetype/src/site/site.xml index 344bd53b..837fea41 100644 --- a/archetypes/alfresco-allinone-archetype/src/site/site.xml +++ b/archetypes/alfresco-allinone-archetype/src/site/site.xml @@ -27,14 +27,14 @@ - + - + - - - + + + diff --git a/archetypes/alfresco-amp-archetype/pom.xml b/archetypes/alfresco-amp-archetype/pom.xml index b643524f..d1a3b794 100644 --- a/archetypes/alfresco-amp-archetype/pom.xml +++ b/archetypes/alfresco-amp-archetype/pom.xml @@ -6,7 +6,7 @@ alfresco-amp-archetype maven-archetype - Repository AMP Archetype from Maven Alfresco SDK + Maven Alfresco SDK - Repository AMP Archetype Sample project with full support for lifecycle and rapid development of Repository AMPs (Alfresco Module Packages) diff --git a/archetypes/alfresco-amp-archetype/src/site/apt/advanced-usage.apt.vm b/archetypes/alfresco-amp-archetype/src/site/apt/advanced-usage.apt.vm index e82778c3..1cb88391 100644 --- a/archetypes/alfresco-amp-archetype/src/site/apt/advanced-usage.apt.vm +++ b/archetypes/alfresco-amp-archetype/src/site/apt/advanced-usage.apt.vm @@ -1,5 +1,5 @@ ------ - Alfresco Maven AMP Archetype Advanced Usage + Maven Alfresco AMP Archetype Advanced Usage ------ Gabriele Columbro ------ diff --git a/archetypes/alfresco-amp-archetype/src/site/apt/usage.apt.vm b/archetypes/alfresco-amp-archetype/src/site/apt/usage.apt.vm index 5ce8a008..37bd8d0d 100644 --- a/archetypes/alfresco-amp-archetype/src/site/apt/usage.apt.vm +++ b/archetypes/alfresco-amp-archetype/src/site/apt/usage.apt.vm @@ -51,7 +51,7 @@ Usage * release and distribution 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 Maven Alfresco plugin used to manage AMPs in this SDK embeds the official Alfresco MMT to install depdended AMPs. Commands diff --git a/archetypes/alfresco-amp-archetype/src/site/site.xml b/archetypes/alfresco-amp-archetype/src/site/site.xml index f85c2ab7..e7f68115 100644 --- a/archetypes/alfresco-amp-archetype/src/site/site.xml +++ b/archetypes/alfresco-amp-archetype/src/site/site.xml @@ -28,14 +28,14 @@ - + - + - - - + + + diff --git a/archetypes/share-amp-archetype/pom.xml b/archetypes/share-amp-archetype/pom.xml index 6045462d..e05cec19 100644 --- a/archetypes/share-amp-archetype/pom.xml +++ b/archetypes/share-amp-archetype/pom.xml @@ -6,7 +6,7 @@ share-amp-archetype maven-archetype - Share AMP Archetype from Maven Alfresco SDK + Maven Alfresco SDK - Share AMP Archetype Share project with full support for lifecycle and rapid development of AMPs (Alfresco Module Packages) diff --git a/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/apt/usage.apt.vm b/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/apt/usage.apt.vm index cf87e300..6c3f8b56 100644 --- a/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/apt/usage.apt.vm +++ b/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/apt/usage.apt.vm @@ -52,7 +52,7 @@ Usage * release and distribution 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 Maven Alfresco plugin used to manage AMPs in this SDK embeds the official Alfresco MMT to install depdended AMPs. Commands diff --git a/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/site.xml b/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/site.xml index 6737ce08..1751116a 100644 --- a/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/site.xml +++ b/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/site.xml @@ -28,14 +28,14 @@ - + - + - - - + + + diff --git a/archetypes/share-amp-archetype/src/site/apt/advanced-usage.apt.vm b/archetypes/share-amp-archetype/src/site/apt/advanced-usage.apt.vm index da021400..bdbd7de7 100644 --- a/archetypes/share-amp-archetype/src/site/apt/advanced-usage.apt.vm +++ b/archetypes/share-amp-archetype/src/site/apt/advanced-usage.apt.vm @@ -1,5 +1,5 @@ ------ - Alfresco Maven AMP Archetype Advanced Usage + Maven Alfresco AMP Archetype Advanced Usage ------ Gabriele Columbro ------ diff --git a/archetypes/share-amp-archetype/src/site/apt/usage.apt.vm b/archetypes/share-amp-archetype/src/site/apt/usage.apt.vm index 906a833f..4c114491 100644 --- a/archetypes/share-amp-archetype/src/site/apt/usage.apt.vm +++ b/archetypes/share-amp-archetype/src/site/apt/usage.apt.vm @@ -1,5 +1,5 @@ ------ - Alfresco Maven AMP Archetype Usage + Maven Alfresco AMP Archetype Usage ------ Gabriele Columbro ------ @@ -49,7 +49,7 @@ Usage * release and distribution 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 Maven Alfresco plugin used to manage AMPs in this SDK embeds the official Alfresco MMT to install depdended AMPs. Commands diff --git a/archetypes/share-amp-archetype/src/site/site.xml b/archetypes/share-amp-archetype/src/site/site.xml index 690489d1..14ef073d 100644 --- a/archetypes/share-amp-archetype/src/site/site.xml +++ b/archetypes/share-amp-archetype/src/site/site.xml @@ -28,13 +28,13 @@ - + - + - - + + diff --git a/modules/alfresco-rad/pom.xml b/modules/alfresco-rad/pom.xml index 854697ef..b7df206c 100644 --- a/modules/alfresco-rad/pom.xml +++ b/modules/alfresco-rad/pom.xml @@ -4,8 +4,8 @@ alfresco-rad jar - Rapid Application Development support - SDK module for Rapid Deveopment support + Rapid Application Development Support + SDK module for Rapid Development support org.alfresco.maven alfresco-sdk-aggregator diff --git a/plugins/alfresco-maven-plugin/pom.xml b/plugins/alfresco-maven-plugin/pom.xml index f165a5bf..4d0052a7 100644 --- a/plugins/alfresco-maven-plugin/pom.xml +++ b/plugins/alfresco-maven-plugin/pom.xml @@ -3,7 +3,7 @@ org.alfresco.maven.plugin alfresco-maven-plugin maven-plugin - Alfresco Maven Plugin + Maven Alfresco Plugin org.alfresco.maven diff --git a/plugins/alfresco-maven-plugin/src/site/apt/advanced-usage.apt.vm b/plugins/alfresco-maven-plugin/src/site/apt/advanced-usage.apt.vm index cedde4be..2ade6bb0 100644 --- a/plugins/alfresco-maven-plugin/src/site/apt/advanced-usage.apt.vm +++ b/plugins/alfresco-maven-plugin/src/site/apt/advanced-usage.apt.vm @@ -8,7 +8,7 @@ Managing AMP packaging projects - See {{{./usage.html} Usage page}} for the different approaches to AMP projects development with the Alfresco Maven Plugin. + See {{{./usage.html} Usage page}} for the different approaches to AMP projects development with the Maven Alfresco Plugin. Overlay and installation of AMPs to WAR @@ -98,7 +98,7 @@ Overlay and installation of AMPs to WAR ** Multiple AMP installation The plugin installation goal is thoroughly documented in the {{{./install-mojo.html} alfresco:install mojo page}}, but we provide here an example of how to mimic the - <<>> (Alfresco script), using the Alfresco Maven Plugin to install a full folder of AMPs (<> The install goal + <<>> (Alfresco script), using the Maven Alfresco Plugin to install a full folder of AMPs (<> The install goal is bound in this case to the <<>> phase, it's up to you to make sure an exploded WAR or WAR is present in warLocation during that phase): diff --git a/plugins/alfresco-maven-plugin/src/site/apt/index.apt.vm b/plugins/alfresco-maven-plugin/src/site/apt/index.apt.vm index 64b33cd0..eaab0bd9 100644 --- a/plugins/alfresco-maven-plugin/src/site/apt/index.apt.vm +++ b/plugins/alfresco-maven-plugin/src/site/apt/index.apt.vm @@ -8,11 +8,11 @@ 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 Maven Alfresco Plugin provides development features to manage {{{http://www.alfresco.com}Alfresco ECM}} WAR and {{{https://wiki.alfresco.com/wiki/AMP_Files}AMP}} project lifecycles. * Goals Overview - The Alfresco Maven plugin has three goals: + The Maven Alfresco plugin has three goals: *{{{./amp-mojo.html}alfresco:amp}} Packages an AMP file @@ -24,10 +24,10 @@ Introduction * 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 Maven Alfresco Plugin can be found on the {{{./usage.html}usage page}}. - The Alfresco Maven Plugin provides support for <<>> packaging in your Maven projects and allows you to + The Maven Alfresco Plugin provides support for <<>> packaging in your Maven projects and allows you to build AMPs as well as used them as standard Maven dependencies. You can also use AMPs as part of the standard {{{http://maven.apache.org/plugins/maven-war-plugin/overlays.html}maven-war-plugin}} <<< >>> configuration. - For more complex usage of the Alfresco Maven Plugin check the {{{./advanced-usage.html}advanced usage page}}. \ No newline at end of file + For more complex usage of the Maven Alfresco Plugin check the {{{./advanced-usage.html}advanced usage page}}. \ No newline at end of file diff --git a/plugins/alfresco-maven-plugin/src/site/apt/plexus-components.apt.vm b/plugins/alfresco-maven-plugin/src/site/apt/plexus-components.apt.vm index 408f936c..0bdb9170 100644 --- a/plugins/alfresco-maven-plugin/src/site/apt/plexus-components.apt.vm +++ b/plugins/alfresco-maven-plugin/src/site/apt/plexus-components.apt.vm @@ -1,7 +1,7 @@ ----- - Alfresco Maven Plugin Components + Maven Alfresco Plugin Components ----- - The Alfresco Maven Plugin defines support components to manage AMP (Alfresco Module Package) lifecycle. + The Maven Alfresco Plugin defines support components to manage AMP (Alfresco Module Package) lifecycle. AMP Lifecycle diff --git a/plugins/alfresco-maven-plugin/src/site/apt/usage.apt.vm b/plugins/alfresco-maven-plugin/src/site/apt/usage.apt.vm index 49ea4de9..c544ccaa 100644 --- a/plugins/alfresco-maven-plugin/src/site/apt/usage.apt.vm +++ b/plugins/alfresco-maven-plugin/src/site/apt/usage.apt.vm @@ -12,7 +12,7 @@ How to use this plugin? [[1]] Using Archetypes provided in the Maven Alfresco SDK - [[2]] By using the Alfresco SDK Parent POM + [[2]] By using the Maven Alfresco SDK Parent POM [[3]] Via direct configuration in your POM @@ -53,7 +53,7 @@ How to use this plugin? <>: The following configuration is not required when using the SDK parent, as it's already included there. - In order to manage AMP artifacts with the Alfresco Maven plugin you need to: + In order to manage AMP artifacts with the Maven Alfresco plugin you need to: * Declare the plugin in your POM with <<<>>> enabled, to allow AMP packaging lifecycle: diff --git a/plugins/alfresco-maven-plugin/src/site/site.xml b/plugins/alfresco-maven-plugin/src/site/site.xml index 98e8fee0..61c106d0 100644 --- a/plugins/alfresco-maven-plugin/src/site/site.xml +++ b/plugins/alfresco-maven-plugin/src/site/site.xml @@ -17,7 +17,7 @@ - + @@ -30,14 +30,14 @@ - + - + - - - + + + diff --git a/poms/alfresco-sdk-parent/pom.xml b/poms/alfresco-sdk-parent/pom.xml index 289bd218..f797ebba 100644 --- a/poms/alfresco-sdk-parent/pom.xml +++ b/poms/alfresco-sdk-parent/pom.xml @@ -2,7 +2,7 @@ 4.0.0 alfresco-sdk-parent - Maven Alfresco SDK Parent POM + Maven Alfresco SDK - Parent POM The Maven Alfresco SDK Parent POM exposes the developer features of the Maven Alfresco SDK. Declare this POM as parent for your project and select the Alfresco version/edition by defining @@ -115,7 +115,7 @@ 2.1 ../../target/staging/poms/alfresco-sdk-parent - + 2.0.0-SNAPSHOT 1.3.174 1.5 diff --git a/poms/alfresco-sdk-parent/src/site/apt/index.apt.vm b/poms/alfresco-sdk-parent/src/site/apt/index.apt.vm index a29c8dc3..b07e9e43 100644 --- a/poms/alfresco-sdk-parent/src/site/apt/index.apt.vm +++ b/poms/alfresco-sdk-parent/src/site/apt/index.apt.vm @@ -8,14 +8,14 @@ Introduction - The Alfresco SDK Parent POM ${project.version} is the <<>> for all Maven Alfresco SDK\x99 features. + The Maven Alfresco SDK Parent POM ${project.version} is the <<>> 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. The current version of the POM in use in the Maven Alfresco SDK\x99 ${project.version} is available {{{https://oss.sonatype.org/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}on Maven Central}}. Usage - You can reference Alfresco SDK POM in your POM adding the following snippet: + You can reference Maven Alfresco SDK POM in your POM adding the following snippet: +---+ @@ -29,7 +29,7 @@ Usage +---+ - This will reference the Alfresco SDK project as <<>> project, allowing you to inherit all SDK features. + This will reference the Maven Alfresco SDK project as <<>> project, allowing you to inherit all SDK features. 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 diff --git a/poms/alfresco-sdk-parent/src/site/apt/sdk-profiles.apt.vm b/poms/alfresco-sdk-parent/src/site/apt/sdk-profiles.apt.vm index 8cf1e552..e0b8434b 100644 --- a/poms/alfresco-sdk-parent/src/site/apt/sdk-profiles.apt.vm +++ b/poms/alfresco-sdk-parent/src/site/apt/sdk-profiles.apt.vm @@ -30,7 +30,7 @@ SDK Available Profiles *-----------+--------------+-------------+-------------+-------------+ The full list of available profiles (with their activation conditions) can be instead found in the <<>> section of the - {{{https://artifacts.alfresco.com/nexus/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}Alfresco SDK POM}}. + {{{https://artifacts.alfresco.com/nexus/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}Maven Alfresco SDK POM}}. Full SDK properties reference diff --git a/poms/alfresco-sdk-parent/src/site/site.xml b/poms/alfresco-sdk-parent/src/site/site.xml index 66258605..6c1b8ae0 100644 --- a/poms/alfresco-sdk-parent/src/site/site.xml +++ b/poms/alfresco-sdk-parent/src/site/site.xml @@ -62,14 +62,14 @@ - + - + - - - + + + diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 8e06fb28..edb0edbe 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -1,7 +1,7 @@ - Maven Alfresco SDK (former Maven Alfresco Lifecycle) + Maven Alfresco SDK (former Alfresco Lifecycle) Gabriele Columbro @@ -41,7 +41,7 @@ Linked all sub modules. - Added this wrapper project to group all Maven Alfresco plugins and archetype useful for the Maven Alfresco Lifecycle support + Added this wrapper project to group all Alfresco plugins and archetype useful for the Alfresco Lifecycle support diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index f476479b..92caef5b 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -1,5 +1,5 @@ ------ - Maven Alfresco SDK\x99 + Maven Alfresco SDK\x99 ------ Gabriele Columbro ------ @@ -8,26 +8,26 @@ Introduction - The (Maven) Alfresco SDK\x99 - formerly {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/index.html} Maven Alfresco Lifecycle 3.9.1}} - + The (Maven) Maven Alfresco SDK\x99 - formerly {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/index.html} 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. 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. The Maven Alfresco SDK\x99 is fully documented in the single components websites (see menu above). - For official (Enterprise) support of this SDK please refer to the features and tutorials documented in {{{http://docs.alfresco.com/community/concepts/alfresco-sdk-intro.html}the Official Alfresco Docs}}. + For official (Enterprise) support of this SDK please refer to the features and tutorials documented in {{{http://docs.alfresco.com/community/concepts/alfresco-sdk-intro.html}the Official Alfresco Documentation}}. How to Use the SDK The easiest way to use the SDK is to create a sample project using one of the available <> (Repo AMP, Share AMP, All in One). - You can also use the Alfresco SDK Parent POM directly in your Maven project to inherit Alfresco behaviors and configurations. + You can also use the Maven Alfresco SDK Parent POM directly in your Maven project to inherit Alfresco behaviors and configurations. SDK Versions - As of version 2.0, releases for the Alfresco SDK are available in Maven Central. + As of version 2.0, releases for the Maven Alfresco SDK are available in Maven Central. - Alfresco SDK 1.x versions rely on the {{{https://artifacts.alfresco.com/nexus/content/groups/public/}Alfresco Artifacts Repository}}. + Maven Alfresco SDK 1.x versions rely on the {{{https://artifacts.alfresco.com/nexus/content/groups/public/}Alfresco Artifacts Repository}}. For documentation on the Maven Alfresco SDK\x99 1.x please refer to {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/index.html} Maven Alfresco SDK 1.x}} SDK Alfresco Compatibility @@ -43,7 +43,7 @@ Maven Alfresco SDK\x99 components * Archetypes like the {{{./archetypes/alfresco-amp-archetype/index.html}Repo AMP}}, {{{./archetypes/share-amp-archetype/index.html}Share 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 - * The {{{./plugins/alfresco-maven-plugin/index.html} Alfresco Maven Plugin}} to manage AMP packaging and dependencies + * The {{{./plugins/alfresco-maven-plugin/index.html} Maven Alfresco Plugin}} to manage AMP packaging and dependencies * {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest}Alfresco Platform Distribution POM}} can (optionally) be used to provide centralized <<<>>> on a particular Alfresco version / edition (Community / Enterprise) @@ -65,18 +65,18 @@ Pre-requisites Project History - * Born in 2007 with the name of {{{http://forge.alfresco.com/gf/project/maven4alfresco/}maven4alfresco}}, later committed on google Code as {{{https://code.google.com/p/maven-alfresco-archetypes/}Maven Alfresco Archetypes}} + * Born in 2007 with the name of {{{http://forge.alfresco.com/gf/project/maven4alfresco/}maven4alfresco}}, later committed on google Code as {{{https://code.google.com/p/maven-alfresco-archetypes/}Alfresco Archetypes}} - * Created in 2008 the {{{https://groups.google.com/forum/?fromgroups#!forum/maven-alfresco}Maven Alfresco Lifecycle Discussion Group}} in order to open roadmap and features with Alfresco Community + * Created in 2008 the {{{https://groups.google.com/forum/?fromgroups#!forum/maven-alfresco}Alfresco Lifecycle Discussion Group}} in order to open roadmap and features with Alfresco Community - * {{{https://artifacts.alfresco.com/}Alfresco Maven Repository}} is {{{http://mindthegab.com/2009/12/02/dreams-come-true-launching-the-alfresco-community-maven-repository/}launched}} in 2009 for Community and Enterprise Alfresco customers + * {{{https://artifacts.alfresco.com/}Maven Alfresco Repository}} is {{{http://mindthegab.com/2009/12/02/dreams-come-true-launching-the-alfresco-community-maven-repository/}launched}} in 2009 for Community and Enterprise Alfresco customers * In April 2012 version {{{https://groups.google.com/forum/?fromgroups=#!searchin/maven-alfresco/3.9.1/maven-alfresco/ZSX1t9W-Jcg/MB-YqAdnCAAJ}3.9.1 is released}}, which delivers Maven build support for all 3.x Alfresco versions - * The {{{https://groups.google.com/forum/?fromgroups#!forum/maven-alfresco}Maven Alfresco Lifecycle Discussion Group}} reaches 100 members in August 2012 + * The {{{https://groups.google.com/forum/?fromgroups#!forum/maven-alfresco}Alfresco Lifecycle Discussion Group}} reaches 100 members in August 2012 * In October 2012 Alfresco finalises the {{{https://issues.alfresco.com/jira/browse/ALF-14353} Maven modularisation and dependency categorisation}}, delivering {{{https://artifacts.alfresco.com}artifacts and poms}} - * The new Alfresco Maven SDK 1.0 is released and presented on Tuesday 7 November at {{{http://devcon.alfresco.com/}Alfresco DevCon}} in Berlin. + * The new Maven Alfresco SDK 1.0 is released and presented on Tuesday 7 November at {{{http://devcon.alfresco.com/}Alfresco DevCon}} in Berlin. - * The new Alfresco Maven SDK 2.0 is released and presented on late 2014 November and released on Maven Central + * The new Maven Alfresco SDK 2.0 is released and presented on late 2014 November and released on Maven Central diff --git a/src/site/apt/prerequisites.apt.vm b/src/site/apt/prerequisites.apt.vm index 4bf50129..f10b46b4 100644 --- a/src/site/apt/prerequisites.apt.vm +++ b/src/site/apt/prerequisites.apt.vm @@ -10,7 +10,7 @@ Maven Alfresco SDK\x99 Pre-Requisites - The only real prerequisite of the Maven Alfresco SDK\x99 Apache Maven 3.0.4 installed (and properly configured) on your machine; + The only real prerequisite of the Maven Alfresco SDK\x99 Apache Maven 3.0.4 installed (and properly configured) on your machine; neither <> nor <> are required. Additional tips: diff --git a/src/site/apt/why.apt.vm b/src/site/apt/why.apt.vm index 4bcbe81e..d22bba73 100644 --- a/src/site/apt/why.apt.vm +++ b/src/site/apt/why.apt.vm @@ -8,9 +8,9 @@ Rationale - The Alfresco Maven SDK introduces a new way of conceiving software development, deployment and release of Alfresco related projects and artifacts. + The Maven Alfresco SDK introduces a new way of conceiving software development, deployment and release of Alfresco related projects and artifacts. In contrast to the manual (and error prone) deployment approach based on an installer / Alfresco WAR distribution(s) and the <<<${extensionRoot}>>>, - the Maven SDK provides a unified access to fine grained Artifacts (jar,war,pom files),] that can be easily integrated + the Maven Alfresco SDK provides a unified access to fine grained Artifacts (jar,war,pom files),] that can be easily integrated in your project by the means of Alfresco-specific Maven components and configurations. The main goal of this SDK is to enable rapid development and prototyping of Alfresco projects, while enabling agile development practices (i.e. TDD, FDD) and fostering process reuse due to standardization diff --git a/src/site/site.xml b/src/site/site.xml index 8f350d94..b9244965 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -57,14 +57,14 @@ - + - + - - - + + +