diff --git a/README.md b/README.md index 2235008e..4de9c26b 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,11 @@ 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. +Includes support for rapid and standard development, testing, packaging, versioning and release of your Alfresco integration and extension projects. For a teaser of the SDK potential check out this video: -It is composed of: +[![Alfresco SDK 2.x teaser](http://img.youtube.com/vi/vgbY9i4w0YU/0.jpg)](https://www.youtube.com/watch?v=vgbY9i4w0YU) + +The SDK 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 @@ -48,6 +50,8 @@ This project is released under the [Apache License, Version 2.0](http://www.apac ## News +- 2014-09-09: SDK 2.0.0-beta-3 released to Maven Central +- 2014-08-30: SDK 2.0.0-beta-1 and 2.0.0-beta-2 available in [Maven Central](http://search.maven.org/#search|ga|1|org.alfresco.maven) - 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 Documentation to this change. diff --git a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/runner/src/main/webapp/index.html b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/runner/src/main/webapp/index.html index f48646b2..af304a08 100644 --- a/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/runner/src/main/webapp/index.html +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/runner/src/main/webapp/index.html @@ -1,10 +1,12 @@ - Alfresco SDK 2.x - Running Alfresco ${alfresco.version} + Alfresco SDK @@alfresco.sdk.parent.version@@ - Running Alfresco ${alfresco.version} Maven Alfresco SDK -

Welcome to the Alfresco SDK powered by Apache Maven! You can access the Alfresco components running embedded below:

+

Congratulations, you are successfully running the All in One project from the Alfresco SDK @@alfresco.sdk.parent.version@@, powered by Apache Maven! +
+ You can access the Alfresco components running embedded below:

- \ No newline at end of file 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 3c678984..1b11d52e 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,9 +1,9 @@ ------ - Maven Alfresco All-in-One Archetype Advanced Usage + Alfresco All-in-One Archetype Advanced Usage ------ Gabriele Columbro ------ - Nov 2012 + Aug 2014 ------ @@ -15,9 +15,9 @@ All-in-One Archetype properties * direclty in *.properties, particularly - * For Alfresco WAR projects + * For the <<>> project - * <</alfresco-global.properties>>> (environment dependent <<>> packaged in the WAR ) + * <</alfresco-global.properties>>> (environment dependent <<>> packaged in the WAR when running directly within the AMP project) * For Alfresco/Share AMP projects diff --git a/archetypes/alfresco-allinone-archetype/src/site/apt/index.apt.vm b/archetypes/alfresco-allinone-archetype/src/site/apt/index.apt.vm index 2f1c2d0b..7444a2ee 100644 --- a/archetypes/alfresco-allinone-archetype/src/site/apt/index.apt.vm +++ b/archetypes/alfresco-allinone-archetype/src/site/apt/index.apt.vm @@ -22,14 +22,22 @@ Introduction * Embedded run in Tomcat and embedded H2 database of the full Alfresco suite, including Repository, Share, Solr - * Support for unit and integration testings + * Support for unit and integration testing and rapid development (using spring-loaded, see run.sh) + + * Seamless IDE integration with Eclipse and Idea How to create a project: - You can create the latest release archetype with the following command: + As of version 2.0-beta-3, you can create a project with the latest released archetype with the following command directly from Maven Central: +---+ -mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: +mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=http://repo1.maven.org/maven2/archetype-catalog.xml ++---+ + + For previous versions, you need to use the Alfresco Artifacts repository: + ++---+ +mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml +---+ You should then: @@ -42,7 +50,14 @@ mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: You can find new Alfresco All-in-One project ready to go in the <<>> folder. +Quickstart + + Once your project is created, enter the project folder and run <<<./run.sh>>> (you might need to <<>> to make it executable. Wait for the startup of the webapps and then go <<>>. + This will start Alfresco, Share and Solr. You can import the projects in your favorite IDE (with Maven integration) and start + developing right away. + Usage - Instructions on how to use the Alfresco All in One archetype can be found on the {{{./usage.html}usage page}}, while + + Full instructions on how to use the Alfresco All in One archetype can be found on the {{{./usage.html}usage page}}, while for more advanced use cases refer to the {{{./advanced-usage.html}advanced usage page}} 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 1299af15..708cb076 100644 --- a/archetypes/alfresco-allinone-archetype/src/site/apt/usage.apt.vm +++ b/archetypes/alfresco-allinone-archetype/src/site/apt/usage.apt.vm @@ -3,7 +3,7 @@ ------ Gabriele Columbro ------ - Nov 2012 + Sep 2013 ------ Prerequisites @@ -16,8 +16,9 @@ Project layout +---+ pom.xml - |-> amp - |-> alfresco + |-> repo-amp + |-> repo + |-> share-amp |-> share |-> solr |-> runner (a Tomcat embedded runner / integration test runner) @@ -48,7 +49,7 @@ Usage * AMP/WAR packaging - * AMP Unit testing + * AMP Unit testing and rapid development * run embedded in Tomcat + H2 database. (<>: this is not a {{{http://www.alfresco.com/services/subscription/supported-platforms/} supported stack}} so use <>) @@ -65,9 +66,11 @@ Usage Commands -* Commands from the root aggregator project +* Commands from the root aggregator project: - Common Alfresco project lifecycle commands you want to run from the aggregator : + * <<>> will automatically set up the SDK and run embedded to enable rapid development + +* Additional Common Maven lifecycle commands you want to run from the aggregator are: * <<>>: Runs unit tests and packages all customized modules in their respective <<<$\{project.build.directory\}/$\{project.build.finalName\}.amp>>> @@ -81,4 +84,4 @@ Commands * Commands from from the <<>> project - * <<>> or <<<'mvn integration-test -Prun'>>> to quickly run already packaged webapps + * <<>> or <<<'mvn integration-test -Prun'>>> to quickly run already packaged webapps diff --git a/archetypes/alfresco-amp-archetype/src/site/apt/index.apt.vm b/archetypes/alfresco-amp-archetype/src/site/apt/index.apt.vm index 26d99ed8..3cfad410 100644 --- a/archetypes/alfresco-amp-archetype/src/site/apt/index.apt.vm +++ b/archetypes/alfresco-amp-archetype/src/site/apt/index.apt.vm @@ -3,7 +3,7 @@ ------ Gabriele Columbro ------ - Nov 2012 + Spt 2014 ------ Introduction @@ -22,17 +22,27 @@ Introduction * Installation of AMPs in an Alfresco WAR * AMP Unit Testing support. Just run the standard <<>> and see your <<>> Alfresco unit tests run. - An sample Unit Test is provided in this archetype. + An sample Unit Test is provided in this archetype. * Embedded run in Tomcat and embedded H2 database for demo purposes, rapid application development and integration testing (<>: this is not a {{{http://www.alfresco.com/services/subscription/supported-platforms/} supported stack}} so use <>) + * Support for (remote) Junit and integration testing and rapid development (using spring-loaded, see run.sh) + + * Seamless IDE integration with Eclipse and Idea + How to create a project: - You can create the latest release archetype with the following command: + As of version 2.0-beta-3, you can create a project with the latest released archetype with the following command directly from Maven Central: +---+ -mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: +mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=http://repo1.maven.org/maven2/archetype-catalog.xml ++---+ + + For previous versions, you need to use the Alfresco Artifacts repository: + ++---+ +mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml +---+ You should then: 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 bdbd7de7..b5afe58d 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,12 +1,12 @@ ------ - Maven Alfresco AMP Archetype Advanced Usage + Alfresco Share AMP Archetype Advanced Usage ------ Gabriele Columbro ------ Nov 2012 ------ -AMP Unit Testing +Unit Testing Unit test your AMP customization is as easy as adding your tests in <<>>. The current module in development will be added to the test classpath together with all necessary Alfresco Spring contexts. @@ -14,9 +14,9 @@ AMP Unit Testing Running <<>> will results in your unit tests to be run. You can skip this (<<>>) adding <<<-DskipTests>>> to your command line. -AMP Archetype properties +Share AMP Archetype properties - In the AMP archetype (as in the whole Part of the Maven Alfresco SDK\x99) properties are configurable at many levels: + In the AMP archetype (as in the whole Alfresco SDK\x99) properties are configurable at many levels: * as POM properties @@ -24,8 +24,6 @@ AMP Archetype properties * <<>> (filtered and packaged in the AMP) - * <</alfresco-global.properties>>> (environment dependent properties for WAR run embedded) - * Common properties Archetype behavior can mostly be controlled directly in the POM, via common properties provided by the parent POM. diff --git a/archetypes/share-amp-archetype/src/site/apt/index.apt.vm b/archetypes/share-amp-archetype/src/site/apt/index.apt.vm index d5be7173..44cb883d 100644 --- a/archetypes/share-amp-archetype/src/site/apt/index.apt.vm +++ b/archetypes/share-amp-archetype/src/site/apt/index.apt.vm @@ -21,20 +21,25 @@ Introduction * Installation of AMPs in an Alfresco or Share WAR - * AMP Unit Testing support. Just run the standard <<>> and see your <<>> Alfresco unit tests run. - An sample Unit Test is provided in this archetype. + * AMP Unit Testing support. Just run the standard <<>> and see your <<>> Alfresco unit tests run. - * Embedded run in Tomcat and embedded H2 database for demo purposes, rapid application development and integration testing - (<>: this is not a {{{http://www.alfresco.com/services/subscription/supported-platforms/} supported stack}} so use <>) + * Support for unit and integration testing and rapid development (using spring-loaded, see run.sh) + + * Seamless IDE integration with Eclipse and Idea How to create a project: - You can create the latest release archetype with the following command: + As of version 2.0-beta-3, you can create a project with the latest released archetype with the following command directly from Maven Central: +---+ -mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: +mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=http://repo1.maven.org/maven2/archetype-catalog.xml +---+ + For previous versions, you need to use the Alfresco Artifacts repository: + ++---+ +mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml ++---+ You should then: [[1]] Select the <<>> option