mirror of
https://github.com/Alfresco/alfresco-sdk.git
synced 2025-10-01 14:41:57 +00:00
-- fixed site:deploy
-- added docs for each modules -- deployed a staging snapshot at https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/index.html -- TODO: check links! git-svn-id: http://maven-alfresco-archetypes.googlecode.com/svn/trunk@633 04253f4f-3451-0410-a141-5562f1e59037
This commit is contained in:
mindthegab
@@ -8,7 +8,7 @@
|
||||
|
||||
Maven Alfresco SDK\x99
|
||||
|
||||
The Alfresco Maven SDK ${project.version} (formerly {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/} Maven Alfresco Lifecycle 3.9.1}}
|
||||
The Alfresco Maven SDK ${project.version} - formerly {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/} Maven Alfresco Lifecycle 3.9.1}} -
|
||||
provides a fully fledged Maven support for {{{http://www.alfresco.com}Alfresco ECM}} WAR and {{{https://wiki.alfresco.com/wiki/AMP_Files}AMP}} project development.
|
||||
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.
|
||||
@@ -17,25 +17,34 @@ Maven Alfresco SDK\x99
|
||||
|
||||
The Maven Alfresco SDK relies on a number of components:
|
||||
|
||||
*{{{./poms/alfresco-sdk-parent/index.html}An SDK POM}} providing full Alfresco project lifecycle feature, to be added as a <<<<parent>>>> in your projects
|
||||
* {{{./poms/alfresco-sdk-parent/index.html}An SDK POM}} providing full Alfresco project lifecycle feature, to be added as a <<<<parent>>>> in your projects
|
||||
|
||||
* Archetypes like the {{{./archetypes/alfresco-amp-archetype/index/html}AMP}} or {{{./archetypes/alfresco-allinone-archetype/index.html}All-in-One}} providing sample project to kickstart your Alfresco development and boost it with best practices
|
||||
* Archetypes like the {{{./archetypes/alfresco-amp-archetype/index.html}AMP}} or {{{./archetypes/alfresco-allinone-archetype/index.html}All-in-One}} providing sample project to kickstart your Alfresco development and boost it with best practices
|
||||
|
||||
*{{{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)
|
||||
* The {{{./plugins/alfresco-maven-plugin/index.html} Alfresco Maven 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)
|
||||
|
||||
*The {{{https://artifacts.alfresco.com}Alfresco Artifacts Repository}} provides backing for this SDK. Check the {{{http://wiki.alfresco.com/wiki/Alfresco_Artifacts_Repository}Alfresco Wiki}} for Community / Enterprise access information.
|
||||
* The {{{https://artifacts.alfresco.com}Alfresco Artifacts Repository}} provides backing for this SDK. Check the {{{http://wiki.alfresco.com/wiki/Alfresco_Artifacts_Repository}Alfresco Wiki}} for Community / Enterprise access information.
|
||||
|
||||
* Usage
|
||||
|
||||
The Maven Alfresco SDK\x99 is fully documented in the single components websites (links above) as well as updated on {{{https://wiki.alfresco.com/wiki/Maven_Alfresco_SDK}the Alfresco Wiki}}.
|
||||
|
||||
* Alfresco Compatibility
|
||||
* Pre-requisites
|
||||
|
||||
** System prerequisites
|
||||
|
||||
No manual Alfresco download, application server or database is required.
|
||||
See details in the {{{./prerequisites.html} SDK pre-requisites page}}.
|
||||
|
||||
** Alfresco Compatibility
|
||||
|
||||
Maven Alfresco SDK\x99 ${project.version} is compatible (for now) with Alfresco Community / Enterprise 4.2(.b)+.
|
||||
The majority of the features might still work when using lower Alfresco versions, but certain artifacts might not be
|
||||
available in the {{{https://artifacts.alfresco.com}Alfresco Artifacts Repository}}. You can probably fix this with some
|
||||
Maven configuration, but use at your own risk.
|
||||
|
||||
|
||||
Project History
|
||||
|
||||
* The Maven Alfresco SDK\x99 reached its version ${project.version}.
|
||||
36
src/site/apt/prerequisites.apt.vm
Normal file
36
src/site/apt/prerequisites.apt.vm
Normal file
@@ -0,0 +1,36 @@
|
||||
------
|
||||
Maven Alfresco SDK Prerequisites
|
||||
------
|
||||
Gabriele Columbro
|
||||
------
|
||||
Nov 2012
|
||||
------
|
||||
|
||||
|
||||
Maven Alfresco SDK\x99 Pre-Requisites
|
||||
|
||||
|
||||
The only real prerequisite of the Maven Alfresco SDK\x99 Apache Maven 3.0.3+ installed (and properly configured) on your machine;
|
||||
neither <<an IDE>> nor <<web container or database>> are required.
|
||||
|
||||
Additional tips:
|
||||
|
||||
* It is strongly advised to use the Apache Maven official binary distributions downloaded from the {{http://maven.apache.org}official mirrors}}; avoid OS-specific distributions as much as possible.
|
||||
|
||||
* add <<<MAVEN_OPTS="-Xms256m -Xmx1G -XX:PermSize=300m">>> to your environment if your plan to launch tests / run embedded in Jetty
|
||||
|
||||
* Java 1.7 is <<required>> to run Alfresco 4.2.b+
|
||||
|
||||
* <<No manual downloading>> of Alfresco distribution is required.
|
||||
Alfresco platform is retrieved automatically from {{{https://artifacts.alfresco.com} the Alfresco Artifacts Repository}}
|
||||
based on the <<<alfresco.groupId>>> and <<<alfresco.version>>> POM properties
|
||||
|
||||
|
||||
H2 Embedded Support Pre-Requisites
|
||||
|
||||
This SDK allows H2 embedded run of Alfresco (<<NOTE>>: this is an unsupported configuration for Alfresco Enterprise) leveraging
|
||||
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
|
||||
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}}.
|
||||
37
src/site/apt/why.apt.vm
Normal file
37
src/site/apt/why.apt.vm
Normal file
@@ -0,0 +1,37 @@
|
||||
------
|
||||
Why using this SDK might be a good idea?
|
||||
------
|
||||
Gabriele Columbro
|
||||
------
|
||||
Nov 2012
|
||||
------
|
||||
|
||||
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 <process reuse> of your development practices,
|
||||
and, in certain successful cases, Application Lifecycle Management process at large.
|
||||
|
||||
Therefore Alfresco Community and Enterprise <developers>, <architects> and <project managers> are the main stakeholders of this tentative to simplify
|
||||
Alfresco development. Hope this helps :)
|
||||
|
||||
* Developer features
|
||||
|
||||
* No manual downloading of Alfresco distribution. It's all retrieved from {{{https://artifacts.alfresco.com} the Alfresco Artifacts Repository}}
|
||||
|
||||
* <<IDE-independent SDK>>, features are provided by Apache Maven, which is the sole prerequisite to use this SDK
|
||||
|
||||
* <<No IDE manual configuration>>, all modern IDEs offer advanced Maven integrations. So feel free to use Eclipse, IntelliJ, or any other IDE to write your code, while leveraging Maven to
|
||||
standardize the way you work on Alfresco in your organization
|
||||
|
||||
* Dependencies, POMs, Javadoc and Sources support - provided by {{{https://artifacts.alfresco.com} the Alfresco Artifacts Repository}} - for all Alfresco Artifacts;
|
||||
Sources / Javadocs are automatically downloaded on demand by your IDE Maven integration (e.g. see {{{http://www.sonatype.org/m2eclipse/} m2eclipse}})
|
||||
|
||||
* <<Process ready>>, as it scales from quick start rapid application development, to be seamlessly integrated in enterprise devleopment processes like Continuous Integration and Release
|
||||
|
||||
* <<Clean and readable>>, with a {{{./poms/alfresco-sdk-parent/index.html}single entry point}} for all SDK functionalities
|
||||
|
||||
* Advanced build functionality, inherited by your parent POMs you can use embedded databases and j2ee containers with a zero configuration approach
|
||||
|
||||
* 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.
|
||||
@@ -13,7 +13,7 @@
|
||||
<href>http://www.alfresco.com</href>
|
||||
</topBarIcon>
|
||||
<topBarEnabled>true</topBarEnabled>
|
||||
<navBarStyle>navbar-inverse</navBarStyle
|
||||
<navBarStyle>navbar-inverse</navBarStyle>
|
||||
<sideBarEnabled>false</sideBarEnabled>
|
||||
<facebookLike />
|
||||
<googlePlusOne />
|
||||
@@ -32,17 +32,20 @@
|
||||
|
||||
<body>
|
||||
|
||||
<menu ref="modules" inherit="bottom"/>
|
||||
|
||||
<menu ref="parent" inherit="bottom"/>
|
||||
|
||||
<menu name="SDK Resources">
|
||||
<item name="FAQ" href="faq.html" />
|
||||
<item name="Alfresco SDK POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/poms/alfresco-sdk-parent/index.html" />
|
||||
<menu name="Maven Alfresco SDK">
|
||||
<item name="Introduction" href="index.html"/>
|
||||
<item name="Maven Alfresco SDK Prerequisites" href="prerequisites.html" />
|
||||
<item name="Maven Alfresco SDK Properties" href="./poms/alfresco-sdk-parent/sdk-properties.html" />
|
||||
<item name="Why using SDK?" href="./why.html" />
|
||||
<item name="Alfresco SDK Parent POM" href="./poms/alfresco-sdk-parent/index.html" />
|
||||
<item name="Alfresco Platform Distribution POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest/index.html" />
|
||||
<item name="Maven AMP Plugin" href="http://maven.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/plugins/maven-amp-plugin/index.html" />
|
||||
</menu>
|
||||
|
||||
<menu ref="modules" inherit="bottom"/>
|
||||
|
||||
<menu name="Community Docs">
|
||||
<item name="Alfresco Maven Wiki Docs" href="http://wiki.alfresco.com/wiki/Maven_Alfresco_SDK" />
|
||||
<item name="Alfresco with Maven for Dummies" href="https://wiki.alfresco.com/wiki/Maven_For_Dummies" />
|
||||
@@ -52,9 +55,8 @@
|
||||
<item name="Carlo Sciolla's blog" href="http://skuro.tk/" />
|
||||
<item name="Enterprise adoption" href="http://www.slideshare.net/guest67a9ba/maven-application-lifecycle-management-for-alfresco" />
|
||||
</menu>
|
||||
|
||||
|
||||
<menu ref="reports" />
|
||||
|
||||
|
||||
</body>
|
||||
</project>
|
||||
|
||||
Reference in New Issue
Block a user