mirror of
https://github.com/Alfresco/alfresco-sdk.git
synced 2025-10-01 14:41:57 +00:00
Tune generated doc (mostly Maven Alfresco SDK -> Alfresco SDK)
This commit is contained in:
Samuel Langlois
@@ -1,5 +1,5 @@
|
||||
------
|
||||
Maven Alfresco SDK\x99
|
||||
Alfresco SDK\x99
|
||||
------
|
||||
Gabriele Columbro
|
||||
------
|
||||
@@ -8,24 +8,24 @@
|
||||
|
||||
Introduction
|
||||
|
||||
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}} -
|
||||
The Alfresco SDK\x99 - formerly 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 Documentation}}.
|
||||
|
||||
How to Use the SDK
|
||||
|
||||
The easiest way to use the SDK is to create a sample project using one of the available <<archetypes>> (Repo AMP, Share AMP, All in One).
|
||||
|
||||
You can also use the Maven Alfresco SDK Parent POM directly in your Maven project to inherit Alfresco behaviors and configurations.
|
||||
You can also use the 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 Maven Alfresco SDK are available in Maven Central.
|
||||
As of version 2.0, releases for the Alfresco SDK are available in Maven Central.
|
||||
|
||||
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}}
|
||||
@@ -35,14 +35,20 @@ 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 <<<<parent>>>> 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
|
||||
|
||||
* Archetypes providing sample project to kickstart your Alfresco development and boost it with best practices
|
||||
|
||||
* the {{{./archetypes/alfresco-amp-archetype/index.html}Repo AMP}}, a single project that customizes Alfresco Repository
|
||||
|
||||
* the {{{./archetypes/share-amp-archetype/index.html}Share AMP}}, a single project that customizes Alfresco Share
|
||||
|
||||
* the {{{./archetypes/alfresco-allinone-archetype/index.html}All-in-One}}, a multi-module project to customize and run all components
|
||||
|
||||
* 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 <<<<dependencyManagement>>>> on a particular Alfresco version / edition (Community / Enterprise)
|
||||
@@ -79,4 +85,4 @@ Project History
|
||||
|
||||
* 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 Maven Alfresco SDK 2.0 is released and presented on late 2014 November and released on Maven Central
|
||||
* The new Alfresco SDK 2.0 is released and presented on late 2014 November and released on Maven Central
|
||||
|
||||
@@ -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 <<an IDE>> nor <<web container or database>> are required.
|
||||
|
||||
Additional tips:
|
||||
@@ -46,7 +46,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}}
|
||||
|
||||
@@ -8,14 +8,14 @@
|
||||
|
||||
Rationale
|
||||
|
||||
The Maven Alfresco SDK introduces a new way of conceiving software development, deployment and release of Alfresco related projects and artifacts.
|
||||
The 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 <infamous> <<<${extensionRoot}>>>,
|
||||
the Maven Alfresco SDK provides a unified access to fine grained Artifacts (jar,war,pom files),] that can be easily integrated
|
||||
the 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 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 <process reuse> of your development practices,
|
||||
and, in certain successful cases, Application Lifecycle Management process at large.
|
||||
@@ -43,4 +43,4 @@ Why would you use the Maven Alfresco SDK\x99?
|
||||
|
||||
* One mvn command to generate, one mvn command to run embedded, this is all you need to do to have a local Alfresco running on an empty laptop
|
||||
|
||||
* Supports community and enterprise seamlessly, allowing to switch one between versions / edition easily.
|
||||
* Supports community and enterprise seamlessly, allowing to switch one between versions / edition easily.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<skin>
|
||||
<groupId>org.apache.maven.skins</groupId>
|
||||
<artifactId>maven-fluido-skin</artifactId>
|
||||
<version>1.3.0</version>
|
||||
<version>1.3.1</version>
|
||||
</skin>
|
||||
<custom>
|
||||
<fluidoSkin>
|
||||
|
||||
Reference in New Issue
Block a user