From 13a384c437e721b1b2ce2f28d44c0ef82df3c052 Mon Sep 17 00:00:00 2001 From: bhagya_silva Date: Thu, 28 Aug 2014 14:32:51 +0200 Subject: [PATCH 01/10] Added bash scripts for ease of use when running from command line. --- .../resources/archetype-resources/repo-amp/run-spring-loaded.sh | 1 + .../src/main/resources/archetype-resources/repo-amp/run.sh | 2 ++ .../archetype-resources/share-amp/run-spring-loaded.sh | 1 + .../src/main/resources/archetype-resources/share-amp/run.sh | 2 ++ 4 files changed, 6 insertions(+) create mode 100644 archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/run-spring-loaded.sh create mode 100644 archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/run.sh create mode 100644 archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/run-spring-loaded.sh create mode 100644 archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/run.sh 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/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..c536a941 --- /dev/null +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-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/share-amp/run.sh b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/run.sh new file mode 100644 index 00000000..e5929027 --- /dev/null +++ b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/share-amp/run.sh @@ -0,0 +1,2 @@ +#!/bin/sh +MAVEN_OPTS="-Xms256m -Xmx2G -XX:PermSize=300m" mvn integration-test -Pamp-to-war From 9aacf6064cdedac4a19e99916d07fb0a3bb40d89 Mon Sep 17 00:00:00 2001 From: bhagya_silva Date: Thu, 28 Aug 2014 14:36:50 +0200 Subject: [PATCH 02/10] Removed JVM options for Alfresco Share Build --- .../archetype-resources/share-amp/run-spring-loaded.sh | 2 +- .../src/main/resources/archetype-resources/share-amp/run.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) 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 index c536a941..10bc9f6a 100644 --- 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 @@ -1 +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 +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 index e5929027..1ae1aec1 100644 --- 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 @@ -1,2 +1,2 @@ #!/bin/sh -MAVEN_OPTS="-Xms256m -Xmx2G -XX:PermSize=300m" mvn integration-test -Pamp-to-war +mvn integration-test -Pamp-to-war From d2517be6a17dcb97e6f7cc1a7f2833652c28f3e0 Mon Sep 17 00:00:00 2001 From: bhagya_silva Date: Thu, 28 Aug 2014 14:41:00 +0200 Subject: [PATCH 03/10] Added Alfresco Share as a provided dependency with classes modifier --- .../archetype-resources/share-amp/pom.xml | 22 +++++++++++++------ 1 file changed, 15 insertions(+), 7 deletions(-) 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..3afad8fa 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 @@ -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 + From a7b553866f8070d1fb70d2b11d178ac8f39854bd Mon Sep 17 00:00:00 2001 From: bhagya_silva Date: Thu, 28 Aug 2014 14:41:58 +0200 Subject: [PATCH 04/10] Updated naming of the archetypes --- archetypes/alfresco-allinone-archetype/pom.xml | 2 +- archetypes/alfresco-amp-archetype/pom.xml | 2 +- archetypes/share-amp-archetype/pom.xml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/archetypes/alfresco-allinone-archetype/pom.xml b/archetypes/alfresco-allinone-archetype/pom.xml index 43c00474..fa7280b9 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 + Alfresco Maven 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-amp-archetype/pom.xml b/archetypes/alfresco-amp-archetype/pom.xml index b643524f..88de5592 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 + Alfresco Maven SDK - Repository AMP Archetype Sample project with full support for lifecycle and rapid development of Repository AMPs (Alfresco Module Packages) diff --git a/archetypes/share-amp-archetype/pom.xml b/archetypes/share-amp-archetype/pom.xml index 6045462d..b03bb956 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 + Alfresco Maven SDK - Share AMP Archtype Share project with full support for lifecycle and rapid development of AMPs (Alfresco Module Packages) From 52aac9ab2bfb9f175c90d44fe0481bf68e6ec8e3 Mon Sep 17 00:00:00 2001 From: bhagya_silva Date: Thu, 28 Aug 2014 14:45:44 +0200 Subject: [PATCH 05/10] Better naming for SDK Modules --- .../resources/archetype-resources/pom.xml | 26 +++++++++---------- .../archetype-resources/repo/pom.xml | 8 +++--- .../archetype-resources/share-amp/pom.xml | 6 ++--- .../archetype-resources/share/pom.xml | 4 +-- .../archetype-resources/solr/pom.xml | 2 +- 5 files changed, 23 insertions(+), 23 deletions(-) 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 3bad8104..34e847fb 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/pom.xml b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo/pom.xml index 9d9ba42a..dc24281b 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 3afad8fa..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} @@ -45,7 +45,7 @@ classes provided - + org.springframework.extensions.surf spring-surf-api 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 60cd1d2e..53ab9f59 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 876fd1ba..2fabd9cc 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 From da5ffcf2a6930e525d389ac0b611e446b3ada54a Mon Sep 17 00:00:00 2001 From: bhagya_silva Date: Thu, 28 Aug 2014 15:09:49 +0200 Subject: [PATCH 06/10] No more Alfresco Maven SDK, just Alfresco SDK. --- README.md | 16 ++++++++-------- archetypes/alfresco-allinone-archetype/pom.xml | 2 +- .../archetype-resources/repo-amp/pom.xml | 2 +- .../src/site/apt/advanced-usage.apt.vm | 2 +- .../src/site/apt/index.apt.vm | 2 +- .../src/site/site.xml | 4 ++-- .../src/site/apt/advanced-usage.apt.vm | 2 +- .../alfresco-amp-archetype/src/site/site.xml | 4 ++-- .../src/site/apt/advanced-usage.apt.vm | 2 +- .../archetype-resources/src/site/site.xml | 4 ++-- .../src/site/apt/advanced-usage.apt.vm | 2 +- .../share-amp-archetype/src/site/site.xml | 4 ++-- .../src/site/apt/usage.apt.vm | 8 ++++---- .../alfresco-maven-plugin/src/site/site.xml | 4 ++-- pom.xml | 6 +++--- poms/alfresco-sdk-parent/pom.xml | 4 ++-- .../src/site/apt/index.apt.vm | 4 ++-- .../src/site/apt/sdk-profiles.apt.vm | 4 ++-- .../src/site/apt/sdk-properties.apt.vm | 2 +- poms/alfresco-sdk-parent/src/site/site.xml | 8 ++++---- src/changes/changes.xml | 6 +++--- src/site/apt/index.apt.vm | 18 +++++++++--------- src/site/apt/prerequisites.apt.vm | 8 ++++---- src/site/apt/why.apt.vm | 2 +- src/site/site.xml | 6 +++--- 25 files changed, 63 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index df8b8d37..8f579ac4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -# [![Maven Alfresco SDK logo](https://github.com/Alfresco/alfresco-sdk/raw/master/src/site/resources/img/alfresco-maven-logo.jpg)](#features) Maven Alfresco SDK +# [![Alfresco SDK logo](https://github.com/Alfresco/alfresco-sdk/raw/master/src/site/resources/img/alfresco-maven-logo.jpg)](#features) 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. +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. It is composed of: @@ -14,13 +16,11 @@ 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 2.x**: Full documentation is available at the [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 docs +### Alfresco Official Documentation 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). @@ -31,7 +31,7 @@ Advanced sample projects are maintained by @ohej in the [Alfresco SDK Samples pr ### 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 diff --git a/archetypes/alfresco-allinone-archetype/pom.xml b/archetypes/alfresco-allinone-archetype/pom.xml index fa7280b9..cc1c25f7 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 - Alfresco Maven SDK - All-in-One Archetype + 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/repo-amp/pom.xml b/archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/repo-amp/pom.xml index 449f9a14..b34dd537 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/site/apt/advanced-usage.apt.vm b/archetypes/alfresco-allinone-archetype/src/site/apt/advanced-usage.apt.vm index 0b54cc81..fda713e2 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 @@ -9,7 +9,7 @@ All-in-One Archetype properties - In each of the modules of the archetype (as in the whole Maven Alfresco SDK\x99) properties are configurable at many levels: + In each of the modules of the archetype (as in the whole Alfresco SDK\x99) properties are configurable at many levels: * as POM properties 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..0d6b2f2f 100644 --- a/archetypes/alfresco-allinone-archetype/src/site/apt/index.apt.vm +++ b/archetypes/alfresco-allinone-archetype/src/site/apt/index.apt.vm @@ -9,7 +9,7 @@ Introduction 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 Alfresco SDK\x99 powerful capabilities to customize and run the full Alfresco platform embedded and all it's components. The archetype does not require additional download and provides a perfect starting point for full-blown Alfresco projects. * Features diff --git a/archetypes/alfresco-allinone-archetype/src/site/site.xml b/archetypes/alfresco-allinone-archetype/src/site/site.xml index 344bd53b..4bd053d6 100644 --- a/archetypes/alfresco-allinone-archetype/src/site/site.xml +++ b/archetypes/alfresco-allinone-archetype/src/site/site.xml @@ -23,7 +23,7 @@ - + @@ -32,7 +32,7 @@ - + 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..4674c84a 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 @@ -16,7 +16,7 @@ AMP Unit Testing 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 Part of the Alfresco SDK\x99) properties are configurable at many levels: * as POM properties diff --git a/archetypes/alfresco-amp-archetype/src/site/site.xml b/archetypes/alfresco-amp-archetype/src/site/site.xml index f85c2ab7..228563ea 100644 --- a/archetypes/alfresco-amp-archetype/src/site/site.xml +++ b/archetypes/alfresco-amp-archetype/src/site/site.xml @@ -24,7 +24,7 @@ - + @@ -33,7 +33,7 @@ - + diff --git a/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/apt/advanced-usage.apt.vm b/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/apt/advanced-usage.apt.vm index c7b25e71..57a6faa7 100644 --- a/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/apt/advanced-usage.apt.vm +++ b/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/apt/advanced-usage.apt.vm @@ -16,7 +16,7 @@ AMP Unit Testing 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 Part of the Alfresco SDK\x99) properties are configurable at many levels: * as POM properties 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..6d62a05f 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 @@ -24,7 +24,7 @@ - + @@ -33,7 +33,7 @@ - + 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..31a613dc 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 @@ -16,7 +16,7 @@ AMP Unit Testing 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 Part of the Alfresco SDK\x99) properties are configurable at many levels: * as POM properties diff --git a/archetypes/share-amp-archetype/src/site/site.xml b/archetypes/share-amp-archetype/src/site/site.xml index 690489d1..08571177 100644 --- a/archetypes/share-amp-archetype/src/site/site.xml +++ b/archetypes/share-amp-archetype/src/site/site.xml @@ -24,7 +24,7 @@ - + @@ -33,7 +33,7 @@ - + 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..8fe61d7c 100644 --- a/plugins/alfresco-maven-plugin/src/site/apt/usage.apt.vm +++ b/plugins/alfresco-maven-plugin/src/site/apt/usage.apt.vm @@ -10,13 +10,13 @@ How to use this plugin? There are fundamentally 3 methods to use this plugin: - [[1]] Using Archetypes provided in the Maven Alfresco SDK + [[1]] Using Archetypes provided in the Alfresco SDK [[2]] By using the Alfresco SDK Parent POM [[3]] Via direct configuration in your POM -* Method 1 - Using Maven Alfresco SDK Archetypes +* Method 1 - Using Alfresco SDK Archetypes Two sample archetypes already use the plugin and provide best practice example on how to use it: @@ -27,9 +27,9 @@ How to use this plugin? This is the <> and less error-prone way of using the plugin. -* Method 2 - Using Maven Alfresco SDK Parent POM +* Method 2 - Using Alfresco SDK Parent POM - The {{{../../poms/alfresco-sdk-parent/index.html}Maven Alfresco SDK Parent POM}} provides a single entry point for all SDK features. + The {{{../../poms/alfresco-sdk-parent/index.html}Alfresco SDK Parent POM}} provides a single entry point for all SDK features. By using it as parent as follows: diff --git a/plugins/alfresco-maven-plugin/src/site/site.xml b/plugins/alfresco-maven-plugin/src/site/site.xml index 98e8fee0..527d12c8 100644 --- a/plugins/alfresco-maven-plugin/src/site/site.xml +++ b/plugins/alfresco-maven-plugin/src/site/site.xml @@ -26,7 +26,7 @@ - + @@ -35,7 +35,7 @@ - + diff --git a/pom.xml b/pom.xml index 0667f325..dafd5d8d 100644 --- a/pom.xml +++ b/pom.xml @@ -4,9 +4,9 @@ org.alfresco.maven alfresco-sdk-aggregator 2.0.0-SNAPSHOT - Maven Alfresco SDK + Alfresco SDK This aggregator Project builds all modules required for - the Maven Alfresco SDK + the Alfresco SDK pom ${maven.site.url} @@ -103,7 +103,7 @@ - + modules/alfresco-rad diff --git a/poms/alfresco-sdk-parent/pom.xml b/poms/alfresco-sdk-parent/pom.xml index 63f09a3b..ba277f68 100644 --- a/poms/alfresco-sdk-parent/pom.xml +++ b/poms/alfresco-sdk-parent/pom.xml @@ -2,9 +2,9 @@ 4.0.0 alfresco-sdk-parent - Maven Alfresco SDK Parent POM + Alfresco SDK Parent POM - The Maven Alfresco SDK Parent POM exposes the developer features of the Maven Alfresco SDK. + The Alfresco SDK Parent POM exposes the developer features of the Alfresco SDK. Declare this POM as parent for your project and select the Alfresco version/edition by defining the alfresco.groupId and alfresco.version in your POM. 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..ce6bfc12 100644 --- a/poms/alfresco-sdk-parent/src/site/apt/index.apt.vm +++ b/poms/alfresco-sdk-parent/src/site/apt/index.apt.vm @@ -8,10 +8,10 @@ Introduction - The Alfresco SDK Parent POM ${project.version} is the <<>> for all Maven Alfresco SDK\x99 features. + The Alfresco SDK Parent POM ${project.version} is the <<>> for all 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}}. + The current version of the POM in use in the 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 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 f701eaf9..78ab3e7e 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 @@ -1,5 +1,5 @@ ------ - Maven Alfresco SDK\x99 Profiles + Alfresco SDK\x99 Profiles ------ Gabriele Columbro ------ @@ -8,7 +8,7 @@ SDK Available Profiles - The Maven Alfresco SDK\x99 defines common features required by different Alfresco projects. + The Alfresco SDK\x99 defines common features required by different Alfresco projects. While the <<>> 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), you can also directly use this POM as a parent in your custom project. diff --git a/poms/alfresco-sdk-parent/src/site/apt/sdk-properties.apt.vm b/poms/alfresco-sdk-parent/src/site/apt/sdk-properties.apt.vm index 324aebea..a41619db 100644 --- a/poms/alfresco-sdk-parent/src/site/apt/sdk-properties.apt.vm +++ b/poms/alfresco-sdk-parent/src/site/apt/sdk-properties.apt.vm @@ -1,5 +1,5 @@ ------ - Maven Alfresco SDK Properties + Alfresco SDK Properties ------ Gabriele Columbro ------ diff --git a/poms/alfresco-sdk-parent/src/site/site.xml b/poms/alfresco-sdk-parent/src/site/site.xml index 66258605..5038ab56 100644 --- a/poms/alfresco-sdk-parent/src/site/site.xml +++ b/poms/alfresco-sdk-parent/src/site/site.xml @@ -53,12 +53,12 @@ - - + + - + @@ -67,7 +67,7 @@ - + diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 8e06fb28..64d4be48 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -1,11 +1,11 @@ - Maven Alfresco SDK (former Maven Alfresco Lifecycle) + Alfresco SDK (former Alfresco Lifecycle) Gabriele Columbro - + Complete re-write of alfresco-maven-plugin to embed Alfresco MMT, therefore maximize alignment / supportability of the build process Introduced a common SDK parent POM (alfresco-sdk-parent), single entry point to access SDK features Introduced a Alfresco platform distribution POM (alfresco-sdk-parent) describing Alfresco artifacts per every release @@ -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..b4db19e2 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -1,5 +1,5 @@ ------ - Maven Alfresco SDK\x99 + Alfresco SDK\x99 ------ Gabriele Columbro ------ @@ -8,12 +8,12 @@ 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) 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). + The 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}}. How to Use the SDK @@ -28,16 +28,16 @@ SDK Versions As of version 2.0, releases for the 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}}. - 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}} + For documentation on the Alfresco SDK\x99 1.x please refer to {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/index.html} Alfresco SDK 1.x}} SDK Alfresco Compatibility Please refer to the {{{http://docs.alfresco.com/community/concepts/alfresco-sdk-compatibility.html}official Alfresco docs}} for details of SDK / Alfresco compatibility. -Maven Alfresco SDK\x99 components +Alfresco SDK\x99 components - The Maven Alfresco SDK relies on a number of components: + The Alfresco SDK relies on a number of components: * {{{./poms/alfresco-sdk-parent/index.html}The SDK parent POM}} providing full Alfresco project lifecycle feature, to be added as a <<<>>> in your projects @@ -65,15 +65,15 @@ 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 * 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}} diff --git a/src/site/apt/prerequisites.apt.vm b/src/site/apt/prerequisites.apt.vm index 4bf50129..9e21833a 100644 --- a/src/site/apt/prerequisites.apt.vm +++ b/src/site/apt/prerequisites.apt.vm @@ -1,5 +1,5 @@ ------ - Maven Alfresco SDK Prerequisites + Alfresco SDK Prerequisites ------ Gabriele Columbro ------ @@ -7,10 +7,10 @@ ------ -Maven Alfresco SDK\x99 Pre-Requisites +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 Alfresco SDK\x99 Apache Maven 3.0.4 installed (and properly configured) on your machine; neither <> nor <> are required. Additional tips: @@ -44,7 +44,7 @@ H2 Embedded Support Pre-Requisites the open source effort {{{https://github.com/skuro/alfresco-h2-support} Alfresco H2 Support}}. This bridge allows to emulate Alfresco expected DB behavior and is therefore very specific to every Alfresco version. - Maven Alfresco SDK\x99 ${project.version} uses version 1.5 of the Alfresco H2 Support. In case you experience + 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}}. Alternatively, you can easily setup your DB access by defining {{{./poms/alfresco-sdk-parent/sdk-properties.html}POM properties}} diff --git a/src/site/apt/why.apt.vm b/src/site/apt/why.apt.vm index 4bcbe81e..aa9ac1d5 100644 --- a/src/site/apt/why.apt.vm +++ b/src/site/apt/why.apt.vm @@ -15,7 +15,7 @@ Rationale enable rapid development and prototyping of Alfresco projects, while enabling agile development practices (i.e. TDD, FDD) and fostering process reuse due to standardization -Why would you use the Maven Alfresco SDK\x99? +Why would you use the Alfresco SDK\x99? As a standard de facto, Maven allows you projects to be inherently more reusable and enables of your development practices, and, in certain successful cases, Application Lifecycle Management process at large. diff --git a/src/site/site.xml b/src/site/site.xml index 8f350d94..0a8bb43c 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -46,14 +46,14 @@ - + - + - + From d2fbf381e59368d6ea77deffe1a14c229b58b26b Mon Sep 17 00:00:00 2001 From: bhagya_silva Date: Thu, 28 Aug 2014 15:34:03 +0200 Subject: [PATCH 07/10] Changed Docs to Documentation --- README.md | 6 +++--- archetypes/alfresco-allinone-archetype/src/site/site.xml | 4 ++-- archetypes/alfresco-amp-archetype/src/site/site.xml | 2 +- archetypes/share-amp-archetype/pom.xml | 2 +- .../main/resources/archetype-resources/src/site/site.xml | 2 +- archetypes/share-amp-archetype/src/site/site.xml | 2 +- modules/alfresco-rad/pom.xml | 2 +- plugins/alfresco-maven-plugin/src/site/site.xml | 2 +- poms/alfresco-sdk-parent/src/site/site.xml | 2 +- src/site/apt/index.apt.vm | 2 +- src/site/site.xml | 6 +++--- 11 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 8f579ac4..ccdeb282 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ It is composed of: ### Alfresco Official Documentation -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 @@ -42,10 +42,10 @@ Alfresco Community artifacts (JARs, WARs, AMPs, poms) and SDK artifacts are publ 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/src/site/site.xml b/archetypes/alfresco-allinone-archetype/src/site/site.xml index 4bd053d6..83466d26 100644 --- a/archetypes/alfresco-allinone-archetype/src/site/site.xml +++ b/archetypes/alfresco-allinone-archetype/src/site/site.xml @@ -32,9 +32,9 @@ - + - + diff --git a/archetypes/alfresco-amp-archetype/src/site/site.xml b/archetypes/alfresco-amp-archetype/src/site/site.xml index 228563ea..8988faae 100644 --- a/archetypes/alfresco-amp-archetype/src/site/site.xml +++ b/archetypes/alfresco-amp-archetype/src/site/site.xml @@ -35,7 +35,7 @@ - + diff --git a/archetypes/share-amp-archetype/pom.xml b/archetypes/share-amp-archetype/pom.xml index b03bb956..ae1b3c55 100644 --- a/archetypes/share-amp-archetype/pom.xml +++ b/archetypes/share-amp-archetype/pom.xml @@ -6,7 +6,7 @@ share-amp-archetype maven-archetype - Alfresco Maven SDK - Share AMP Archtype + Alfresco Maven 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/site.xml b/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/site.xml index 6d62a05f..38ab8a03 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 @@ -35,7 +35,7 @@ - + diff --git a/archetypes/share-amp-archetype/src/site/site.xml b/archetypes/share-amp-archetype/src/site/site.xml index 08571177..cba79df1 100644 --- a/archetypes/share-amp-archetype/src/site/site.xml +++ b/archetypes/share-amp-archetype/src/site/site.xml @@ -34,7 +34,7 @@ - + diff --git a/modules/alfresco-rad/pom.xml b/modules/alfresco-rad/pom.xml index 854697ef..df987cb8 100644 --- a/modules/alfresco-rad/pom.xml +++ b/modules/alfresco-rad/pom.xml @@ -4,7 +4,7 @@ alfresco-rad jar - Rapid Application Development support + Rapid Application Development Support SDK module for Rapid Deveopment support org.alfresco.maven diff --git a/plugins/alfresco-maven-plugin/src/site/site.xml b/plugins/alfresco-maven-plugin/src/site/site.xml index 527d12c8..c3099f26 100644 --- a/plugins/alfresco-maven-plugin/src/site/site.xml +++ b/plugins/alfresco-maven-plugin/src/site/site.xml @@ -37,7 +37,7 @@ - + diff --git a/poms/alfresco-sdk-parent/src/site/site.xml b/poms/alfresco-sdk-parent/src/site/site.xml index 5038ab56..7d7c29de 100644 --- a/poms/alfresco-sdk-parent/src/site/site.xml +++ b/poms/alfresco-sdk-parent/src/site/site.xml @@ -69,7 +69,7 @@ - + diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index b4db19e2..58e22f4d 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -14,7 +14,7 @@ Introduction project easily in Open Source and Enterprise development processes. The 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 diff --git a/src/site/site.xml b/src/site/site.xml index 0a8bb43c..871446ed 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -62,9 +62,9 @@ - - - + + + From 90e8f951974c5bc51125167335832a7f7794a782 Mon Sep 17 00:00:00 2001 From: bhagya_silva Date: Thu, 28 Aug 2014 15:41:13 +0200 Subject: [PATCH 08/10] Fixed SDK Naming Across all projects --- README.md | 10 +++---- .../alfresco-allinone-archetype/pom.xml | 2 +- .../main/java/org/alfresco/demoamp/Demo.java | 2 +- .../org/alfresco/demoamp/DemoComponent.java | 2 +- .../src/site/apt/advanced-usage.apt.vm | 4 +-- .../src/site/apt/index.apt.vm | 2 +- .../src/site/apt/usage.apt.vm | 4 +-- .../src/site/site.xml | 10 +++---- archetypes/alfresco-amp-archetype/pom.xml | 2 +- .../src/site/apt/advanced-usage.apt.vm | 4 +-- .../src/site/apt/usage.apt.vm | 2 +- .../alfresco-amp-archetype/src/site/site.xml | 10 +++---- archetypes/share-amp-archetype/pom.xml | 2 +- .../src/site/apt/advanced-usage.apt.vm | 2 +- .../src/site/apt/usage.apt.vm | 2 +- .../archetype-resources/src/site/site.xml | 10 +++---- .../src/site/apt/advanced-usage.apt.vm | 4 +-- .../src/site/apt/usage.apt.vm | 4 +-- .../share-amp-archetype/src/site/site.xml | 8 +++--- plugins/alfresco-maven-plugin/pom.xml | 2 +- .../src/site/apt/advanced-usage.apt.vm | 4 +-- .../src/site/apt/index.apt.vm | 10 +++---- .../src/site/apt/plexus-components.apt.vm | 4 +-- .../src/site/apt/usage.apt.vm | 12 ++++----- .../alfresco-maven-plugin/src/site/site.xml | 12 ++++----- pom.xml | 6 ++--- poms/alfresco-sdk-parent/pom.xml | 6 ++--- .../src/site/apt/index.apt.vm | 8 +++--- .../src/site/apt/sdk-profiles.apt.vm | 6 ++--- .../src/site/apt/sdk-properties.apt.vm | 2 +- poms/alfresco-sdk-parent/src/site/site.xml | 14 +++++----- src/changes/changes.xml | 4 +-- src/site/apt/index.apt.vm | 26 +++++++++---------- src/site/apt/prerequisites.apt.vm | 8 +++--- src/site/apt/why.apt.vm | 6 ++--- src/site/site.xml | 14 +++++----- 36 files changed, 115 insertions(+), 115 deletions(-) diff --git a/README.md b/README.md index ccdeb282..f63bc71e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# [![Alfresco SDK logo](https://github.com/Alfresco/alfresco-sdk/raw/master/src/site/resources/img/alfresco-maven-logo.jpg)](#features) Alfresco SDK +# [![Maven Alfresco SDK logo](https://github.com/Alfresco/alfresco-sdk/raw/master/src/site/resources/img/alfresco-maven-logo.jpg)](#features) Maven Alfresco SDK -Alfresco SDK based on Apache Maven. +Maven 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. @@ -18,7 +18,7 @@ It is composed of: ### Developer Documentation -**SDK 2.x**: Full documentation is available at the [Alfresco SDK site](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-sdk-aggregator/latest/index.html). +**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). ### Alfresco Official Documentation @@ -26,7 +26,7 @@ Additional documentation for Alfresco Community and Enterprise, tutorials and ex ### 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 @@ -35,7 +35,7 @@ Report issues (and contribute!) [here](https://github.com/Alfresco/alfresco-sdk/ ## 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. diff --git a/archetypes/alfresco-allinone-archetype/pom.xml b/archetypes/alfresco-allinone-archetype/pom.xml index cc1c25f7..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 - Alfresco SDK - All-in-One Archetype + 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/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/site/apt/advanced-usage.apt.vm b/archetypes/alfresco-allinone-archetype/src/site/apt/advanced-usage.apt.vm index fda713e2..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 ------ @@ -9,7 +9,7 @@ All-in-One Archetype properties - In each of the modules of the archetype (as in the whole Alfresco SDK\x99) properties are configurable at many levels: + In each of the modules of the archetype (as in the whole Maven Alfresco SDK\x99) properties are configurable at many levels: * as POM properties 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 0d6b2f2f..2f1c2d0b 100644 --- a/archetypes/alfresco-allinone-archetype/src/site/apt/index.apt.vm +++ b/archetypes/alfresco-allinone-archetype/src/site/apt/index.apt.vm @@ -9,7 +9,7 @@ Introduction The Alfresco All-in-One Archetype is a multi-module project, - leveraging 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. The archetype does not require additional download and provides a perfect starting point for full-blown Alfresco projects. * Features 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 83466d26..837fea41 100644 --- a/archetypes/alfresco-allinone-archetype/src/site/site.xml +++ b/archetypes/alfresco-allinone-archetype/src/site/site.xml @@ -23,18 +23,18 @@ - + - + - + - - + + diff --git a/archetypes/alfresco-amp-archetype/pom.xml b/archetypes/alfresco-amp-archetype/pom.xml index 88de5592..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 - Alfresco Maven SDK - Repository AMP Archetype + 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 4674c84a..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 ------ @@ -16,7 +16,7 @@ AMP Unit Testing AMP Archetype properties - In the AMP archetype (as in the whole Part of the Alfresco SDK\x99) properties are configurable at many levels: + In the AMP archetype (as in the whole Part of the Maven Alfresco SDK\x99) properties are configurable at many levels: * as POM properties 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 8988faae..e7f68115 100644 --- a/archetypes/alfresco-amp-archetype/src/site/site.xml +++ b/archetypes/alfresco-amp-archetype/src/site/site.xml @@ -24,18 +24,18 @@ - + - + - + - - + + diff --git a/archetypes/share-amp-archetype/pom.xml b/archetypes/share-amp-archetype/pom.xml index ae1b3c55..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 - Alfresco Maven SDK - Share AMP Archetype + 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/advanced-usage.apt.vm b/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/apt/advanced-usage.apt.vm index 57a6faa7..c7b25e71 100644 --- a/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/apt/advanced-usage.apt.vm +++ b/archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/apt/advanced-usage.apt.vm @@ -16,7 +16,7 @@ AMP Unit Testing Share AMP Archetype properties - In the AMP archetype (as in the whole Part of the Alfresco SDK\x99) properties are configurable at many levels: + In the AMP archetype (as in the whole Part of the Maven Alfresco SDK\x99) properties are configurable at many levels: * as POM properties 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 38ab8a03..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 @@ -24,18 +24,18 @@ - + - + - + - - + + 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 31a613dc..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 ------ @@ -16,7 +16,7 @@ AMP Unit Testing AMP Archetype properties - In the AMP archetype (as in the whole Part of the Alfresco SDK\x99) properties are configurable at many levels: + In the AMP archetype (as in the whole Part of the Maven Alfresco SDK\x99) properties are configurable at many levels: * as POM properties 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 cba79df1..14ef073d 100644 --- a/archetypes/share-amp-archetype/src/site/site.xml +++ b/archetypes/share-amp-archetype/src/site/site.xml @@ -24,17 +24,17 @@ - + - + - + - + diff --git a/plugins/alfresco-maven-plugin/pom.xml b/plugins/alfresco-maven-plugin/pom.xml index 3d3c92c0..cdd34797 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 8fe61d7c..c544ccaa 100644 --- a/plugins/alfresco-maven-plugin/src/site/apt/usage.apt.vm +++ b/plugins/alfresco-maven-plugin/src/site/apt/usage.apt.vm @@ -10,13 +10,13 @@ How to use this plugin? There are fundamentally 3 methods to use this plugin: - [[1]] Using Archetypes provided in the Alfresco SDK + [[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 -* Method 1 - Using Alfresco SDK Archetypes +* Method 1 - Using Maven Alfresco SDK Archetypes Two sample archetypes already use the plugin and provide best practice example on how to use it: @@ -27,9 +27,9 @@ How to use this plugin? This is the <> and less error-prone way of using the plugin. -* Method 2 - Using Alfresco SDK Parent POM +* Method 2 - Using Maven Alfresco SDK Parent POM - The {{{../../poms/alfresco-sdk-parent/index.html}Alfresco SDK Parent POM}} provides a single entry point for all SDK features. + The {{{../../poms/alfresco-sdk-parent/index.html}Maven Alfresco SDK Parent POM}} provides a single entry point for all SDK features. By using it as parent as follows: @@ -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 c3099f26..61c106d0 100644 --- a/plugins/alfresco-maven-plugin/src/site/site.xml +++ b/plugins/alfresco-maven-plugin/src/site/site.xml @@ -17,7 +17,7 @@ - + @@ -26,18 +26,18 @@ - + - + - + - - + + diff --git a/pom.xml b/pom.xml index dafd5d8d..0667f325 100644 --- a/pom.xml +++ b/pom.xml @@ -4,9 +4,9 @@ org.alfresco.maven alfresco-sdk-aggregator 2.0.0-SNAPSHOT - Alfresco SDK + Maven Alfresco SDK This aggregator Project builds all modules required for - the Alfresco SDK + the Maven Alfresco SDK pom ${maven.site.url} @@ -103,7 +103,7 @@ - + modules/alfresco-rad diff --git a/poms/alfresco-sdk-parent/pom.xml b/poms/alfresco-sdk-parent/pom.xml index ba277f68..5e147601 100644 --- a/poms/alfresco-sdk-parent/pom.xml +++ b/poms/alfresco-sdk-parent/pom.xml @@ -2,9 +2,9 @@ 4.0.0 alfresco-sdk-parent - Alfresco SDK Parent POM + Maven Alfresco SDK - Parent POM - The Alfresco SDK Parent POM exposes the developer features of the Alfresco SDK. + 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 the alfresco.groupId and alfresco.version in your POM. @@ -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 ce6bfc12..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 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 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}}. + 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 78ab3e7e..e8a09d2a 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 @@ -1,5 +1,5 @@ ------ - Alfresco SDK\x99 Profiles + Maven Alfresco SDK\x99 Profiles ------ Gabriele Columbro ------ @@ -8,7 +8,7 @@ SDK Available Profiles - The 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 <<>> 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), you can also directly use this POM as a parent in your custom project. @@ -28,7 +28,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/apt/sdk-properties.apt.vm b/poms/alfresco-sdk-parent/src/site/apt/sdk-properties.apt.vm index a41619db..324aebea 100644 --- a/poms/alfresco-sdk-parent/src/site/apt/sdk-properties.apt.vm +++ b/poms/alfresco-sdk-parent/src/site/apt/sdk-properties.apt.vm @@ -1,5 +1,5 @@ ------ - Alfresco SDK Properties + Maven Alfresco SDK Properties ------ Gabriele Columbro ------ diff --git a/poms/alfresco-sdk-parent/src/site/site.xml b/poms/alfresco-sdk-parent/src/site/site.xml index 7d7c29de..6c1b8ae0 100644 --- a/poms/alfresco-sdk-parent/src/site/site.xml +++ b/poms/alfresco-sdk-parent/src/site/site.xml @@ -53,23 +53,23 @@ - - + + - + - + - + - - + + diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 64d4be48..edb0edbe 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -1,11 +1,11 @@ - Alfresco SDK (former Alfresco Lifecycle) + Maven Alfresco SDK (former Alfresco Lifecycle) Gabriele Columbro - + Complete re-write of alfresco-maven-plugin to embed Alfresco MMT, therefore maximize alignment / supportability of the build process Introduced a common SDK parent POM (alfresco-sdk-parent), single entry point to access SDK features Introduced a Alfresco platform distribution POM (alfresco-sdk-parent) describing Alfresco artifacts per every release diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index 58e22f4d..92caef5b 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -1,5 +1,5 @@ ------ - Alfresco SDK\x99 + Maven Alfresco SDK\x99 ------ Gabriele Columbro ------ @@ -8,42 +8,42 @@ Introduction - The (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}} - + 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 Alfresco SDK\x99 is fully documented in the single components websites (see menu above). + 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 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}}. - For documentation on the Alfresco SDK\x99 1.x please refer to {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/index.html} Alfresco SDK 1.x}} + 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 Please refer to the {{{http://docs.alfresco.com/community/concepts/alfresco-sdk-compatibility.html}official Alfresco docs}} for details of SDK / Alfresco compatibility. -Alfresco SDK\x99 components +Maven Alfresco SDK\x99 components - The Alfresco SDK relies on a number of components: + The Maven Alfresco SDK relies on a number of components: * {{{./poms/alfresco-sdk-parent/index.html}The SDK parent POM}} providing full Alfresco project lifecycle feature, to be added as a <<<>>> in your projects * 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) @@ -69,7 +69,7 @@ Project History * 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 @@ -77,6 +77,6 @@ Project History * 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 9e21833a..f10b46b4 100644 --- a/src/site/apt/prerequisites.apt.vm +++ b/src/site/apt/prerequisites.apt.vm @@ -1,5 +1,5 @@ ------ - Alfresco SDK Prerequisites + Maven Alfresco SDK Prerequisites ------ Gabriele Columbro ------ @@ -7,10 +7,10 @@ ------ -Alfresco SDK\x99 Pre-Requisites +Maven Alfresco SDK\x99 Pre-Requisites - The only real prerequisite of the 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: @@ -44,7 +44,7 @@ H2 Embedded Support Pre-Requisites the open source effort {{{https://github.com/skuro/alfresco-h2-support} Alfresco H2 Support}}. This bridge allows to emulate Alfresco expected DB behavior and is therefore very specific to every Alfresco version. - 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}}. Alternatively, you can easily setup your DB access by defining {{{./poms/alfresco-sdk-parent/sdk-properties.html}POM properties}} diff --git a/src/site/apt/why.apt.vm b/src/site/apt/why.apt.vm index aa9ac1d5..d22bba73 100644 --- a/src/site/apt/why.apt.vm +++ b/src/site/apt/why.apt.vm @@ -8,14 +8,14 @@ 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 -Why would you use the Alfresco SDK\x99? +Why would you use the Maven Alfresco SDK\x99? As a standard de facto, Maven allows you projects to be inherently more reusable and enables of your development practices, and, in certain successful cases, Application Lifecycle Management process at large. diff --git a/src/site/site.xml b/src/site/site.xml index 871446ed..b9244965 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -46,25 +46,25 @@ - + - + - + - + - + - - + + From 6fb92cf40b8817a73056ccf084e8641e818cf6c5 Mon Sep 17 00:00:00 2001 From: bhagya_silva Date: Thu, 28 Aug 2014 15:50:48 +0200 Subject: [PATCH 09/10] Updated read me --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f63bc71e..2235008e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # [![Maven Alfresco SDK logo](https://github.com/Alfresco/alfresco-sdk/raw/master/src/site/resources/img/alfresco-maven-logo.jpg)](#features) Maven Alfresco SDK -Maven Alfresco SDK based on Apache Maven. +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. @@ -8,7 +8,7 @@ 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) @@ -35,7 +35,9 @@ Report issues (and contribute!) [here](https://github.com/Alfresco/alfresco-sdk/ ## Maven Repositories -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/). +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. From 53547a4d8b708757ae3e6a5668c74c4c0a47b45b Mon Sep 17 00:00:00 2001 From: bhagya_silva Date: Thu, 28 Aug 2014 16:03:26 +0200 Subject: [PATCH 10/10] Fixed typo --- modules/alfresco-rad/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/alfresco-rad/pom.xml b/modules/alfresco-rad/pom.xml index df987cb8..b7df206c 100644 --- a/modules/alfresco-rad/pom.xml +++ b/modules/alfresco-rad/pom.xml @@ -5,7 +5,7 @@ jar Rapid Application Development Support - SDK module for Rapid Deveopment support + SDK module for Rapid Development support org.alfresco.maven alfresco-sdk-aggregator